Skip to main content
GET
/
{projectApiKey}
/
customers-metrics
Get customer metrics (Analytics)
curl --request GET \
  --url https://api.qonversion.io/v1/analytics/{projectApiKey}/customers-metrics
{
  "data": {
    "clientsWithEvent": 15420,
    "activeSubscribers": 4230,
    "churnedSubscribers": 43,
    "activeTrials": 820,
    "canceledTrials": 35,
    "billingRetry": 120,
    "avgPaymentCount": 2.4,
    "avgPrice": 9.95,
    "sales": 380276.24
  }
}

Documentation Index

Fetch the complete documentation index at: https://documentation.qonversion.io/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
projectApiKey
string
required

Project API Key for authentication and project identification. A 32-character alphanumeric string copied from Project Settings -> Project Keys -> API Key in https://dash.qonversion.io/. The key has no fixed prefix.

Minimum string length: 1
Example:

"JFPATc4VaaWYsfurml3qZ4zsmNw0VfWH"

Query Parameters

​
environment
enum<integer>
default:1

Environment type (0=Sandbox, 1=Production).

Available options:
0,
1
​
search
string

Universal search (same semantics as /customers).

Maximum string length: 255
​
filter[since][]
integer<int64>[]

Date-range filter on customer first-seen time. Pass exactly two values: filter[since][]=<from_unix_ts>&filter[since][]=<to_unix_ts>. If omitted, both bounds default to the current time and the result will be empty.

Required array length: 2 elements
​
filter[status][]
enum<string>[]

Filter by customer status. Numeric codes:

  • 1 = Trial / Intro
  • 2 = Active
  • 3 = Canceled
  • 4 = Billing Retry
Available options:
1,
2,
3,
4
​
filter[target_platform][]
enum<string>[]

Filter by platforms.

Available options:
iOS,
Android,
Stripe
​
filter[country][]
string[]

Filter by countries (ISO 3166-1 alpha-2).

Pattern: ^[A-Z]{2}$
​
filter[product_id][]
string[]

Filter by product IDs.

​
filter[purchase_currency][]
string[]

Filter by purchase currencies (ISO 4217).

Pattern: ^[A-Z]{3}$
​
filter[locale][]
string[]

Filter by locales.

​
filter[model][]
string[]

Filter by device models.

​
filter[os_version][]
string[]

Filter by OS versions.

​
filter[app_version][]
string[]

Filter by app versions.

​
filter[sdk_version][]
string[]

Filter by SDK versions.

​
filter[media_source_name][]
string[]

Filter by media source names.

​
filter[campaign_name][]
string[]

Filter by campaign names.

​
filter[ad_set_name][]
string[]

Filter by ad set names.

​
filter[ad_name][]
string[]

Filter by ad names.

​
filter[experiment_uid][]
string[]

Filter by experiment UIDs.

​
filter[experiment_group_uid][]
string[]

Filter by experiment group UIDs.

Response

Successful response with aggregated customer metrics

​
data
object
required

Aggregated customer metrics for the project, scoped to the requested filters.