Skip to main content
GET
Get aggregated customer metrics

Authorizations

Authorization
string
header
required

Bearer authentication using the project Secret Key (prefixed with sk_, or test_sk_ for sandbox). All v4 public endpoints require the Secret Key — see Authentication. Never expose the Secret Key in client-side code.

Query Parameters

environment
enum<integer>

Filter by environment: 0 = sandbox, 1 = production.

Available options:
0,
1

Search query string.

filter[status][]
string[]

Filter by customer status. Repeatable.

filter[target_platform][]
string[]

Filter by target platform. Repeatable.

Response

Customer metrics data.

Aggregated customer metrics wrapped in the v4 envelope (object, url). Scalar counters reflect the current filter set (environment, status, platform, search).