jobStatistics

Count of total records that match the query results

Returns the count of total records that match the query results provided in the input.

Search syntax details

• q - the query for the search you want total number of records for.
• search - the match criteria for a simple search
• groupBy - Optional. The field that is used to separate counts by value.
• spatialExtent - Optional. Spatial extent string to filter jobs by their locations
• hasLocation - Optional. Whether or not jobs with defined location in jobLocation are returned

Result syntax details

• total - The number of total results returned for the search

Body parameter

1
2
3
4
5
6
7
{
  "q": "string",
  "search": "string",
  "groupBy": "string",
  "spatialExtent": "string",
  "hasLocation": true
}

Query parameters

Path parameters

Examples

Request

1
2
3
4
5
# You can also use wget
curl -X POST /{orgId}/{itemId}/jobs/statistics \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

1
2
3
4
5
6
7
8
9
10
{
  "total": 0,
  "groupBy": "string",
  "groupedValues": [
    {
      "value": "string",
      "count": 0
    }
  ]
}