Skip to main content
GET
/
{projectApiKey}
/
chart
/
users-overview
Get users overview chart data
curl --request GET \
  --url https://api.qonversion.io/v1/analytics/{projectApiKey}/chart/users-overview
{
  "data": {
    "code": "proceeds",
    "from": 1699000000,
    "to": 1701000000,
    "unit": "day",
    "environment": 1,
    "seriesRelation": "partsOfWhole",
    "maxSeries": 50,
    "totalType": "sum",
    "measure": "usd",
    "horizontalLabelType": "default",
    "series": [
      {
        "label": "After refunds",
        "data": [
          {
            "start_time": 1699000000,
            "value": 6163.49
          }
        ],
        "total": 380276.24,
        "totalPrev": 326882.25,
        "totalWeight": null,
        "totalPrevWeight": null,
        "totalIgnoreInFinal": false
      }
    ],
    "segmentation": "country",
    "summarySeries": {
      "label": "After refunds",
      "data": [
        {
          "start_time": 1699000000,
          "value": 6163.49
        }
      ],
      "total": 380276.24,
      "totalPrev": 326882.25,
      "totalWeight": null,
      "totalPrevWeight": null,
      "totalIgnoreInFinal": false
    }
  }
}

Path Parameters

​
projectApiKey
string
required

Project API Key for authentication and project identification

Pattern: ^proj_[a-zA-Z0-9]+$
Example:

"proj_abc123xyz456"

Query Parameters

​
from
integer<int64>

Start of time range (Unix timestamp)

​
to
integer<int64>

End of time range (Unix timestamp)

​
unit
enum<string>
default:day

Time grouping unit

Available options:
hour,
day,
week,
month
​
environment
enum<integer>
default:1

Environment type (0=Sandbox, 1=Production)

Available options:
0,
1
​
max_series
integer
default:50

Maximum number of series to return

Required range: 0 <= x <= 500
​
segmentation
string

Group by dimension

​
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[locale][]
string[]

Filter by locales

​
filter[model][]
string[]

Filter by device models

​
filter[os_version][]
string[]

Filter by OS versions

​
filter[sdk_version][]
string[]

Filter by SDK versions

​
filter[q_user_id]
string

Filter by Qonversion user ID

​
filter[user_id]
string

Filter by custom user ID

​
filter[device_id]
string

Filter by device ID

​
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

Response

Successful response with chart data

​
data
object
required