get/{tenantId}/v1/locations/stats

Get location statistics

Requires Authentication

Locations

Returns summary statistics for location searches including trends

Name	Type	Description
`tenantId` required	`string (uuid)`	Tenant UUID

Name	Type	Description
`dateFrom` required	`string (date)`	Start date for the query range (ISO 8601 format, e.g., 2024-01-01 or 2024-01-01T00:00:00Z)
`dateTo` required	`string (date)`	End date for the query range (ISO 8601 format, e.g., 2024-01-31 or 2024-01-31T23:59:59Z)

Location statistics

Response Bodyapplication/json

totalSearches

integer (int32)

- Total number of searches in the period

successRate

number (double)

- Percentage of successful searches (0-100)

avgResponseTimeMs

integer (int32)

- Average response time in milliseconds

creditsUsed

integer (int64)

- Total credits consumed

totalSearchesTrend

number (double)

- Percentage change from previous period

successRateTrend

number (double)

- Percentage change from previous period

avgResponseTimeTrend

number (double)

- Percentage change from previous period

creditsUsedTrend

number (double)

- Percentage change from previous period

validationErrors

integer (int32)

- Number of validation errors (invalid postcode format)

notFoundErrors

integer (int32)

- Number of not found errors (valid postcode but no addresses)

serviceErrors

integer (int32)

- Number of service errors (external service failures)

curl -X GET 'https://api-next.checkio.co.uk/{tenantId}/v1/locations/stats?dateFrom={dateFrom}&dateTo={dateTo}' \
  -H 'Authorization: Bearer {token}'