Partner ApiAnalytics

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:

ParameterTypeRequiredDescription
startDatestringNoStart date (ISO 8601 or YYYY-MM-DD)
endDatestringNoEnd 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
}
FieldDescription
totalOrganizationsTotal number of organizations under the partner
activeOrganizationsOrganizations with activity in the period
totalIdentificationsTotal visitor identifications in the period
creditsRemainingCredits available in the pool
creditsUsedCredits 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/usage

Query Parameters:

ParameterTypeRequiredDescription
startDatestringNoStart date (ISO 8601 or YYYY-MM-DD)
endDatestringNoEnd date (ISO 8601 or YYYY-MM-DD)

Response:

{
  "totalQuantity": 4500,
  "totalEvents": 5200,
  "startDate": "2025-02-01",
  "endDate": "2025-02-27"
}
FieldDescription
totalQuantityTotal usage quantity (identifications, etc.)
totalEventsTotal events (may include page views, sessions)
startDatePeriod start
endDatePeriod 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"