WIwithterminal
Data Management

List Row Counts

Changed on

Retrieve row counts by model for a connection. Omit groupBy for totals over the date range, use groupBy=day for daily rows, use groupBy=vehicle for per-vehicle totals, or combine both (for example groupBy=day,vehicle) for per-day, per-vehicle rows.

get/ingestion/row-counts

Request

  • Base URL
    https://api.withterminal.com/tsp/v1
  • URL
    https://api.withterminal.com/tsp/v1/ingestion/row-counts
  • Auth
    HTTP bearer

Query parameters

startDatestring date required
Example:2021-01-06

Include records from on or after a specific date.

endDatestring date required
Example:2021-01-06

Include records from on or before a specific date.

groupBy'day' | 'vehicle' | 'day,vehicle' | 'vehicle,day'

Used to control the aggregation of row counts. Use 'day' for daily rows, 'vehicle' for per-vehicle totals over the range, or combine both keys for per-day, per-vehicle rows. Omit this field for totals over the full date range.

vehicleIdsstring

Comma separated list of vehicle IDs to filter by. Only supported for vehicle-based models. Each ID must use the vcl_ prefix.

modelsstring required

Comma separated list of model names to include.

cursorstring cursor
Example:cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Pagination cursor to start requests from

limitinteger

The maximum number of results to return in a page.

Headers

X-Application-Idstring

Scopes the request to a Terminal application in the caller's organization. Required for multi-application organizations when using a user session or OAuth access token. API keys are already bound to a single application.

Connection-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

The token returned when a user authenticated their account. This authorizes access to a specific account.

Response

OK

nextstring cursor

Cursor used for pagination.

Example response

{
  "results": [
    {
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Changes