Skip to main content
POST
Count analytics events

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

appUuid
string<uuid>
required

App whose analytics events to count.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
kinds
enum<string>[]

Event kinds to include.

Available options:
pageview,
error,
custom

Match against event name, pathname, or error message.

Required string length: 1 - 512
occurredAfter
string

Count events that occurred after this ISO timestamp.

occurredBefore
string

Count events that occurred before this ISO timestamp.

Response

Count analytics events

count
integer
required

Number of analytics events matching the filters.

Required range: 0 <= x <= 9007199254740991