REregrid
Metadata

Usage Detailed

Changed on

Detailed usage breakdown grouped by country and service. Same date range and history parameters as /usage.

get/usage/detailed

Request

  • Base URL
    https://app.regrid.com/api/v2
  • URL
    https://app.regrid.com/api/v2/usage/detailed
  • Auth
    • API key in header x-regrid-token
    • or API key in query parameter token

Query parameters

return_full_historyboolean

Set to true if you would like the entire API usage history.

begin_datestring

optional, datatype:date, YYYY-MM-DD returns the usage from the specified beginning date to current date unless 'end_date' is used.

end_datestring

optional, datatype: date, YYYY-MM-DD returns the usage for all usage up until the specified ending date unless 'begin_date' is used and when.

return_by_tokenboolean

optional, returns usage by all available tokens. See by_token array in response of each token's usage data.

return_by_this_tokenboolean

optional, returns usage for only this token.

Response

OK Usage Detailed response body

Example response

{
  "usage": {
    "cycle_usage": [
      {
        "country": "US",
        "service": "api"
      }
    ],
    "date_range": {
      "total": [
        {
          "country": "US",
          "service": "api"
        }
      ]
    },
    "full_history": [
      {
        "total": [
          {
            "country": "US",
            "service": "api"
          }
        ],
        "counts": [
          {
            "country": "US",
            "service": "api"
          }
        ]
      }
    ]
  }
}

Changes