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/analyticsQuery 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:
curl -X GET "https://api.app.bullseye.so/api/v1/partner/analytics?startDate=2025-02-01&endDate=2025-02-27"
-H "X-Partner-API-Key: your-api-key"Get Usage Summary
Retrieve usage summary with total quantity and event counts.
Request:
GET /partner/usageQuery 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:
{
"totalQuantity": 4500,
"totalEvents": 5200,
"startDate": "2025-02-01",
"endDate": "2025-02-27"
}| Field | Description |
|---|---|
totalQuantity | Total usage quantity (identifications, etc.) |
totalEvents | Total events (may include page views, sessions) |
startDate | Period start |
endDate | Period end |
Example:
curl -X GET "https://api.app.bullseye.so/api/v1/partner/usage?startDate=2025-02-01&endDate=2025-02-27"
-H "X-Partner-API-Key: your-api-key"