Visitor countries chart

Get time-series visitor country data

Permission Required: analytics:read

GET /v2/access/analytics/visitor-countries/chart

Visitor countries chart

cURL

curl --request GET \
  --url https://api.ofauth.com/v2/access/analytics/visitor-countries/chart \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'

200

{
  "isAvailable": true,
  "chart": {
    "visitors": [
      {
        "date": "<string>",
        "count": 123
      }
    ],
    "duration": [
      {
        "date": "<string>",
        "count": 123
      }
    ]
  },
  "total": {
    "current": "<string>",
    "delta": 123
  },
  "hasStats": true
}

Authorizations

apiKey · string · header · required

Your OFAuth API key for authenticating requests.

x-connection-id · string · header · required

Requires a connection via the x-connection-id header.

Query Parameters

startDate · Option 1 · string Option 2 · string Option 3 · any

Start of date range (ISO 8601)

endDate · Option 1 · string Option 2 · string Option 3 · any

End of date range (ISO 8601)

by · enum<string>

Visitor metric to chart

Available options: guests, total, users

Response

200

application/json

Successful response

isAvailable · boolean · required

chart · object · required

Show child attributes

total · object · required

Show child attributes

hasStats · boolean · required