Skip to main content
GET
Get locations

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_date
string<date-time>
required

Inclusive ISO 8601 start date.

end_date
string<date-time>
required

Inclusive ISO 8601 end date.

type
enum<string>
default:country
Available options:
country,
region,
city
limit
integer
Required range: 1 <= x <= 100

Response

200 - application/json

Successful response.

data
object[]
required
total
integer
required

Sum across every row before the limit cut.

complete
boolean
required

Always true on a 200. A failed read is a 503, never an empty success.

type
string

Echo of the requested type.