Analytics

Retrieve partner-level analytics and usage data. Use these endpoints to monitor identification volume, organization activity, and credit consumption over time.

Get Analytics

Retrieve analytics summary for the partner account over a date range.

Request:

GET /partner/analytics

Query Parameters:

Parameter
Type
Required
Description

startDate

string

No

Start date (ISO 8601 or YYYY-MM-DD)

endDate

string

No

End date (ISO 8601 or YYYY-MM-DD)

Response:

{
  "partnerId": "uuid",
  "startDate": "2025-02-01",
  "endDate": "2025-02-27",
  "totalOrganizations": 25,
  "activeOrganizations": 22,
  "totalIdentifications": 4500,
  "creditsRemaining": 5500,
  "creditsUsed": 4500
}
Field
Description

totalOrganizations

Total number of organizations under the partner

activeOrganizations

Organizations with activity in the period

totalIdentifications

Total visitor identifications in the period

creditsRemaining

Credits available in the pool

creditsUsed

Credits consumed in the period

Example:


Get Usage Summary

Retrieve usage summary with total quantity and event counts.

Request:

Query Parameters:

Parameter
Type
Required
Description

startDate

string

No

Start date (ISO 8601 or YYYY-MM-DD)

endDate

string

No

End date (ISO 8601 or YYYY-MM-DD)

Response:

Field
Description

totalQuantity

Total usage quantity (identifications, etc.)

totalEvents

Total events (may include page views, sessions)

startDate

Period start

endDate

Period end

Example:

Last updated