jobStatistics

POST
Use dark colors for code blocksCopy
/{orgId}/{itemId}/jobs/statistics

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

Query parameters

Name	Type	Required
`token`	`string¦null`

Body parameters

Supported content types: application/json

Type: JobStatisticsQuery

The statistics request

Name	Type	Required
`q`	`string¦null`
`search`	`string¦null`
`groupBy`	`string¦null`
`spatialExtent`	`string¦null`
`hasLocation`	`boolean¦null`

Path parameters

Name	Type	Required
`orgId`	`string`
`itemId`	`string`

Response status

Status	Meaning	Description	Schema
200	OK	Job Statistics	JobStatistics

Examples

Request

Use dark colors for code blocksCopy
# You can also use wget
curl -X POST /{orgId}/{itemId}/jobs/statistics \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  --data '{"q":"string","search":"string","groupBy":"string","spatialExtent":"string","hasLocation":true}'

Response

Use dark colors for code blocksCopy
{
  "total": 0,
  "groupBy": "string",
  "groupedValues": [
    {
      "value": "string",
      "count": 0
    }
  ]
}