jobStatistics

POST
Use dark colors for code blocksCopy
1
/{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

NameTypeRequired

token

string

Body parameters

Supported content types: application/json

NameTypeRequiredDescription

The statistics request

body

The statistics request

Path parameters

NameTypeRequired

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
5
6
# 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}' \
  --data '{"q":"string","search":"string","groupBy":"string","spatialExtent":"string","hasLocation":true}'

Response

StatusMeaningDescriptionSchema

200

OK

Job Statistics

JobStatistics

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.