Requests

Get Request Count

Changed on

Retrieve the daily count of API requests made by your team within a specified date range. Filter by types, exact endpoint path, origin, API key or search_pattern_key. credit_start_datetime/credit_end_datetime selects requests by charge date and suppresses request-date defaults; returned buckets still use the actual request date. credit_types selects positive API or Company credit charges. min_credits_consumed/max_credits_consumed bound the total (api + ui) credits a request consumed, matching the filter on the request list.

get/v0/requests/count

Request

  • Base URL
    https://api.theirstack.com
  • URL
    https://api.theirstack.com/v0/requests/count
  • Auth
    HTTP bearer

Query parameters

start_datetimestring date-time nullable

Start datetime in ISO format (e.g., 2023-01-01T00:00:00)

end_datetimestring date-time nullable

End datetime in ISO format (e.g., 2023-01-01T23:59:59)

is_origin_appboolean nullable

Filter by origin app or api

origin'api' | 'app' | 'web' | 'mcp' | 'admin_mcp'

Filter by request origin (api, app, web, mcp)

api_key_idstring uuid nullable

Filter by API key id

search_pattern_keystring nullable
endpointstring nullable

Exact request URL path, e.g. /v1/jobs/search; host and query string are ignored.

credit_start_datetimestring date-time nullable

Start of the charge-date window (inclusive), independent of when requests ran.

credit_end_datetimestring date-time nullable

End of the charge-date window (inclusive).

credit_typesRequestCreditType[] nullable

Only requests with positive charges of these types in the charge window: api or ui (Company credits). Returned credit totals use the same window and selected types.

typesRequestType[] nullable

Filter by search type.

endpointsstring[] nullable

Match any exact request URL path; unassigned selects charges without a recorded endpoint. Intersects the singular endpoint filter.

status_codesinteger[] nullable

Match any HTTP response status code.

min_credits_consumedinteger nullable

Only requests whose total (api + ui) credits consumed are at least this.

max_credits_consumedinteger nullable

Only requests whose total (api + ui) credits consumed are at most this.

timezonestring

IANA timezone, such as Europe/Madrid.

Response

Successful Response

period_startstring date-time required

Start of the period.

number_of_requestsinteger required

Number of requests.

Changes

  • 16937613a4ecRevision changes
    • warning

      deleted the query request parameter campaign_key

    • info

      added the new optional query request parameter search_pattern_key

  • 6862391ec53dRevision changes
    • info

      added the new optional query request parameter campaign_key

    • info

      added the new optional query request parameter credit_end_datetime

    • info

      added the new optional query request parameter credit_start_datetime

    • info

      added the new optional query request parameter credit_types

    • info

      added the new optional query request parameter endpoint

    • info

      added the new optional query request parameter endpoints

    • info

      added the new optional query request parameter max_credits_consumed

    • info

      added the new optional query request parameter min_credits_consumed

    • info

      added the new optional query request parameter origins

    • info

      added the new optional query request parameter status_codes

    • info

      added the new optional query request parameter types