Try our GraphQL Playground
We've included some static documentation below, however GraphQL APIs are traditionally represented through interactive playgrounds. HOVER GraphQL Playground
Introduction
An estimate group gets generated as a result of the sales rep completing the estimation process. An estimate is generated for each selected trade template in the estimation process. This collection of estimates is called an Estimate Group.
Each Estimate Group can have one or more estimates associated with multiple templates and trades.
Queries
estimationEstimateGroups
estimationEstimateGroupsThis query will return all the estimate groups associated with a job. You can determine this by passing the jobId variable into the query. If the response is empty, there are no estimates associated with the job.
{
estimationEstimateGroups(jobId: job_id) {
nodes {
id ## id of an estimate group
updatedAt ## date last updated
}
}
"data": {
"estimationEstimateGroups": {
"nodes": [
{
"id": 228456,
"updatedAt": "2020-06-25T08:52:04Z"
},
{
"id": 228457,
"updatedAt": "2020-06-25T08:52:45Z"
}
]
}
}
}
curl -X POST "https://graph.hover.to/graphql" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-d '{"query": "{ estimationEstimateGroups(jobId: \"job_id\") { nodes { id updatedAt } } }"}'
Request:
Method: POST
URL: https://graph.hover.to/graphql
Headers:
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN
Body:
Type: Raw (JSON)
Content:
{
"query": "{ estimationEstimateGroups(jobId: \"job_id\") { nodes { id updatedAt } } }"
}
Arguments
Additional arguments can be supplied within the query to return a specific subset of estimate groups, for example:
estimationEstimateGroups(last: 30, jobId: 123456)
| Arguments | Description | Accepts |
|---|---|---|
after | Returns the elements in the list that come after the specified cursor. | int |
before | Returns the elements in the list that come before the specified cursor. | int |
first | Returns the first n elements from the list. | int |
last | Returns the last n elements from the list. | int |
jobId | Only return records for this job | int |
In addition to top level arguments, you can specify an argument for active estimates. An active estimate is one that has been marked as sold and is being used in production.
estimates(active: true)
| Argument | Description | Accepts |
|---|---|---|
active | Whether or not the estimate is active within an estimate group | boolean |
Get All Estimate Groups Detailed
Job information and sales opportunity information can be retrieved alongside estimate groups.
{
estimationEstimateGroups(jobId: 12345) {
nodes {
id ## query for active estimate group id
createdAt ## query for creation date
updatedAt ## query for last updated date
estimates { ##view all estimates
active ## query if estimate is active (sold)
basePrice ## query for base price of estimate
totalPrice ## query for total price of estimate
name ## query for name of estimate
}
salesOpportunity { ## include sales opportunity info
soldEstimateGroupId ## query for estimate group marked as sold in opportunity
productionList {
id ## query for production list id
## production list can be expanded here: see Material List
}
soldEstimateGroup { ## include sold estimate group info
estimates { ## specify properties for each estimate
id ## query for estimate id
userId ## query for id of creating user
createdAt ## query for creation date
updatedAt ## query for last updated date
name ## query for name of estimate
active ## query if estimate is active
tradeType ## query for type of trade
}
}
}
}
}
}
{
"data": {
"estimationEstimateGroups": {
"nodes": [
{
"id": "3b9f8a00-d5dc-4b70-bfc7-49b229b84d14",
"createdAt": "2024-07-26T05:15:44Z",
"updatedAt": "2024-07-26T05:15:47Z",
"estimates": [
{
"active": false,
"basePrice": 63665.33257270187,
"totalPrice": 63665.33257270187,
"name": "Good - Timberline HDZ"
},
{
"active": false,
"basePrice": 90186.44428751801,
"totalPrice": 90186.44428751801,
"name": "Best - Timberline Ultra HD"
},
{
"active": false,
"basePrice": 67004.13000134008,
"totalPrice": 67004.13000134008,
"name": "Better - Timberline American Harvest"
}
],
"salesOpportunity": {
"soldEstimateGroupId": null,
"productionList": {
"id": 328322
},
"soldEstimateGroup": null
}
},
{
"id": "70a17c91-21bc-4231-8990-6f224300c9cb",
"createdAt": "2024-07-26T04:59:06Z",
"updatedAt": "2024-07-26T04:59:09Z",
"estimates": [
{
"active": true,
"basePrice": 91110.84785896508,
"totalPrice": 91110.84785896508,
"name": "Best - Timberline Ultra HD"
},
{
"active": false,
"basePrice": 67928.53357278714,
"totalPrice": 67928.53357278714,
"name": "Better - Timberline American Harvest"
},
{
"active": false,
"basePrice": 64589.73614414894,
"totalPrice": 64589.73614414894,
"name": "Good - Timberline HDZ"
}
],
"salesOpportunity": {
"soldEstimateGroupId": null,
"productionList": {
"id": 328322
},
"soldEstimateGroup": null
}
},
{
"id": "e9cd5e76-45fa-4494-b96d-daff411a03f8",
"createdAt": "2024-06-07T17:08:34Z",
"updatedAt": "2024-06-07T17:08:42Z",
"estimates": [
{
"active": true,
"basePrice": 5096.4441582825,
"totalPrice": 5096.4441582825,
"name": "Gutters"
},
{
"active": true,
"basePrice": 56067.62585826421,
"totalPrice": 56067.62585826421,
"name": "Better - Timberline American Harvest"
},
{
"active": false,
"basePrice": 53300.48357249458,
"totalPrice": 53300.48357249458,
"name": "Good - Timberline HDZ"
},
{
"active": true,
"basePrice": 4367.813571515928,
"totalPrice": 4367.813571515928,
"name": "Hardie Soffit"
}
],
"salesOpportunity": {
"soldEstimateGroupId": null,
"productionList": {
"id": 328322
},
"soldEstimateGroup": null
}
},
{
"id": "ff5575c2-1f51-4010-99f6-528c69af064a",
"createdAt": "2024-06-06T20:59:35Z",
"updatedAt": "2024-06-06T20:59:46Z",
"estimates": [
{
"active": false,
"basePrice": 67129.40571562831,
"totalPrice": 67129.40571562831,
"name": "Better - Timberline American Harvest"
},
{
"active": true,
"basePrice": 63790.6082869901,
"totalPrice": 63790.6082869901,
"name": "Good - Timberline HDZ"
},
{
"active": true,
"basePrice": 106175.9945925,
"totalPrice": 106175.9945925,
"name": "Alside - Conquest"
},
{
"active": false,
"basePrice": 122330.92625,
"totalPrice": 122330.92625,
"name": "Alside - Board & Batten"
}
],
"salesOpportunity": {
"soldEstimateGroupId": null,
"productionList": {
"id": 328322
},
"soldEstimateGroup": null
}
},
{
"id": "14b3f123-37d3-48fb-b92b-de33c293af4e",
"createdAt": "2024-04-19T17:14:26Z",
"updatedAt": "2024-04-19T17:16:23Z",
"estimates": [
{
"active": true,
"basePrice": 61843.41757266544,
"totalPrice": 61843.41757266544,
"name": "Better - Timberline American Harvest"
},
{
"active": true,
"basePrice": 141813.8360028363,
"totalPrice": 141813.8360028363,
"name": "7.25\" HardiePlankĀ®"
},
{
"active": false,
"basePrice": 143939.4674314502,
"totalPrice": 143939.4674314502,
"name": "8.25\" HardiePlankĀ®"
},
{
"active": false,
"basePrice": 58786.30528689001,
"totalPrice": 58786.30528689001,
"name": "Good - Timberline HDZ"
}
],
"salesOpportunity": {
"soldEstimateGroupId": null,
"productionList": {
"id": 328322
},
"soldEstimateGroup": null
}
},
{
"id": "9c3095b9-372c-4bd2-9d91-1321ba81a761",
"createdAt": "2024-04-10T14:26:22Z",
"updatedAt": "2024-04-10T14:26:33Z",
"estimates": [
{
"active": true,
"basePrice": 67179.61928705788,
"totalPrice": 67179.61928705788,
"name": "Better - Timberline American Harvest"
},
{
"active": false,
"basePrice": 63840.82185841967,
"totalPrice": 63840.82185841967,
"name": "Good - Timberline HDZ"
},
{
"active": true,
"basePrice": 98265.5323975,
"totalPrice": 98265.5323975,
"name": "Alside - Conquest"
},
{
"active": false,
"basePrice": 114796.33875,
"totalPrice": 114796.33875,
"name": "Alside - Board & Batten"
}
],
"salesOpportunity": {
"soldEstimateGroupId": null,
"productionList": {
"id": 328322
},
"soldEstimateGroup": null
}
},
{
"id": "8e62df0d-a4c9-4f87-9e44-78adcf149ff6",
"createdAt": "2024-03-27T15:29:32Z",
"updatedAt": "2024-03-27T15:29:40Z",
"estimates": [
{
"active": false,
"basePrice": 151705.3134316055,
"totalPrice": 151705.3134316055,
"name": "8.25\" HardiePlankĀ®"
},
{
"active": false,
"basePrice": 63093.94428697616,
"totalPrice": 63093.94428697616,
"name": "Better - Timberline American Harvest"
},
{
"active": true,
"basePrice": 60036.83200120074,
"totalPrice": 60036.83200120074,
"name": "Good - Timberline HDZ"
},
{
"active": true,
"basePrice": 149579.6820029916,
"totalPrice": 149579.6820029916,
"name": "7.25\" HardiePlankĀ®"
}
],
"salesOpportunity": {
"soldEstimateGroupId": null,
"productionList": {
"id": 328322
},
"soldEstimateGroup": null
}
},
{
"id": "df632b72-c6e9-4f50-b380-95f4f441527b",
"createdAt": "2024-03-26T17:22:59Z",
"updatedAt": "2024-03-26T17:23:10Z",
"estimates": [
{
"active": true,
"basePrice": 147205.504860087,
"totalPrice": 147205.504860087,
"name": "7.25\" HardiePlankĀ®"
},
{
"active": true,
"basePrice": 6098.46005268,
"totalPrice": 6098.46005268,
"name": "Gutters"
},
{
"active": false,
"basePrice": 67196.66285848679,
"totalPrice": 67196.66285848679,
"name": "Better - Timberline American Harvest"
},
{
"active": true,
"basePrice": 63857.86542984859,
"totalPrice": 63857.86542984859,
"name": "Good - Timberline HDZ"
},
{
"active": false,
"basePrice": 149235.906288699,
"totalPrice": 149235.906288699,
"name": "8.25\" HardiePlankĀ®"
}
],
"salesOpportunity": {
"soldEstimateGroupId": null,
"productionList": {
"id": 328322
},
"soldEstimateGroup": null
}
},
{
"id": "edeb033b-7d74-49b8-8445-ba4a2dfc6e0a",
"createdAt": "2024-03-12T14:58:03Z",
"updatedAt": "2024-03-12T14:58:13Z",
"estimates": [
{
"active": false,
"basePrice": 0,
"totalPrice": 0,
"name": "Hardie Soffit"
},
{
"active": false,
"basePrice": 63093.94428697616,
"totalPrice": 63093.94428697616,
"name": "Better - Timberline American Harvest"
},
{
"active": true,
"basePrice": 60036.83200120074,
"totalPrice": 60036.83200120074,
"name": "Good - Timberline HDZ"
},
{
"active": true,
"basePrice": 97611.98144498,
"totalPrice": 97611.98144498,
"name": "Alside - Conquest"
},
{
"active": false,
"basePrice": 114131.32073,
"totalPrice": 114131.32073,
"name": "Alside - Board & Batten"
}
],
"salesOpportunity": {
"soldEstimateGroupId": null,
"productionList": {
"id": 328322
},
"soldEstimateGroup": null
}
},
{
"id": "45a4fd4d-ebb5-4f1f-a1ad-98f84a0aede7",
"createdAt": "2024-03-07T21:51:16Z",
"updatedAt": "2024-03-07T21:51:23Z",
"estimates": [
{
"active": false,
"basePrice": 90186.53000180374,
"totalPrice": 90186.53000180374,
"name": "Best - Timberline Ultra HD"
},
{
"active": true,
"basePrice": 67004.2157156258,
"totalPrice": 67004.2157156258,
"name": "Better - Timberline American Harvest"
},
{
"active": true,
"basePrice": 120738.9822,
"totalPrice": 120738.9822,
"name": "Alside - Board & Batten"
}
],
"salesOpportunity": {
"soldEstimateGroupId": null,
"productionList": {
"id": 328322
},
"soldEstimateGroup": null
}
},
{
"id": "3dd14e65-b272-486f-a1e9-fbe00faa7eb0",
"createdAt": "2024-02-15T17:29:34Z",
"updatedAt": "2024-02-15T17:29:43Z",
"estimates": [
{
"active": false,
"basePrice": 84573.88857312004,
"totalPrice": 84573.88857312004,
"name": "Best - Timberline Ultra HD"
},
{
"active": true,
"basePrice": 63234.26714412183,
"totalPrice": 63234.26714412183,
"name": "Better - Timberline American Harvest"
},
{
"active": true,
"basePrice": 117485.26710688,
"totalPrice": 117485.26710688,
"name": "Alside - Conquest"
},
{
"active": false,
"basePrice": 134353.29888,
"totalPrice": 134353.29888,
"name": "Alside - Board & Batten"
}
],
"salesOpportunity": {
"soldEstimateGroupId": null,
"productionList": {
"id": 328322
},
"soldEstimateGroup": null
}
},
{
"id": "ced4a0eb-9a86-4e78-b473-3807d0ea2af2",
"createdAt": "2024-01-18T18:29:22Z",
"updatedAt": "2024-01-18T18:29:29Z",
"estimates": [
{
"active": true,
"basePrice": 63665.41828698759,
"totalPrice": 63665.41828698759,
"name": "Good - Timberline HDZ"
},
{
"active": false,
"basePrice": 90186.53000180374,
"totalPrice": 90186.53000180374,
"name": "Best - Timberline Ultra HD"
},
{
"active": false,
"basePrice": 67004.2157156258,
"totalPrice": 67004.2157156258,
"name": "Better - Timberline American Harvest"
}
],
"salesOpportunity": {
"soldEstimateGroupId": null,
"productionList": {
"id": 328322
},
"soldEstimateGroup": null
}
},
{
"id": "9595246f-7316-4a1a-b3ec-345ec9b64ce6",
"createdAt": "2024-01-12T16:39:18Z",
"updatedAt": "2024-01-12T16:39:24Z",
"estimates": [
{
"active": false,
"basePrice": 0,
"totalPrice": 0,
"name": "Hardie Soffit"
},
{
"active": false,
"basePrice": 0,
"totalPrice": 0,
"name": "Gutters"
},
{
"active": true,
"basePrice": 97611.98144498,
"totalPrice": 97611.98144498,
"name": "Alside - Conquest"
},
{
"active": true,
"basePrice": 63093.94428697616,
"totalPrice": 63093.94428697616,
"name": "Better - Timberline American Harvest"
}
],
"salesOpportunity": {
"soldEstimateGroupId": null,
"productionList": {
"id": 328322
},
"soldEstimateGroup": null
}
}
]
}
}
}
curl -X POST "https://graph.hover.to/graphql" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-d '{"query": "{ estimationEstimateGroups(jobId: \"job_id\") { nodes { id createdAt updatedAt salesOpportunity { soldEstimateGroupId productionList { id } soldEstimateGroup { estimates { id userId createdAt updatedAt name active tradeType } } } } } }"}'
Request:
Method: POST
URL: https://graph.hover.to/graphql
Headers:
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN
Body:
Type: Raw (JSON)
Content:
{
"query": "{ estimationEstimateGroups(jobId: \"job_id\") { nodes { id createdAt updatedAt salesOpportunity { soldEstimateGroupId productionList { id } soldEstimateGroup { estimates { id userId createdAt updatedAt name active tradeType } } } } } }"
}