International

Usage

Check your current API usage stats to see how many requests, parcel records, and tiles have been used. You can see full history with using the parameter 'return_full_history' or specify a specific date range.

get/{country}/usage/detailed

Request

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

Path parameters

country'ca' | 'ch' | 'cy' | 'cz' | 'de' | 'dk' | 'ee' | 'es' | 'fi' | 'fr' | 'gb' | 'ie' | 'is' | 'it' | 'lu' | 'lv' | 'nl' | 'no' | 'pl' | 'si' | 'sk' required

ISO 3166-1 alpha-2 country code for international data.

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 response body

Changes

No recorded changes to this operation across all 1 revision of this API.