Funnel Progression

The Funnel Progression API provides access to the same data that's available on the Game Progression Funnel page in the justtrack platform.

Table & graph API

Send a POST request to:

curl -H X-API-Key: <API_KEY> https://api.justtrack.io/reporting/v1/funnel/progression

Request

{
    "interval": {
        "from": "2023-08-01",
        "until": "2023-08-02"
    },
    "metrics": [
        "churnRate",
        "usersOfStepOne"
    ],
    "dimension": "eventDimension[DIMENSION NAME]",
    "filters": {
        "<dimension>": [string]
    },
    "pagination": {
        "page": 0,
        "limit": 25
    }
}

Name	Type	Description
dimension	string	A dimension by which game events will be selected. Here, you have two options depends on your SDK setup:eventDimension[element_id]eventDimension[jt_level_name]. Refer to our supported request values for options.
metrics	[]string	List of requested metrics. Refer to our supported request values for options.
interval	Interval object	An interval within which data should be aggregated.
filters	Filters object	Optional filters to limit requested. Refer to our supported request values for options.
pagination	Pagination object	Batch number and amount of data rows to return.

Responses

200

{
   "pagination": {
       "page": int,
       "limit": int,
       "total": int
   },
   "rows": [
       {
           "event": string,
           "step": string,
           "<dimension>": string,
           "<metric>": float
       }
   ]
}

Name	Type	Description
pagination	Pagination object	Used pagination settings and total amount of data rows.
rows	[]Row	A list of data rows. Also rows objects always contain event and step fields with corresponding values.

400

If you provide a valid JSON request body but with a data error, you'll receive an INVALID_ARGUMENT response:

{
    "code": 400,
    "requestId": "a0b12345-6c78-90123-4def-ghij56789012",
    "details": [
        "requested metrics are not supported: [<INVALID_METRICS>]",
        "requested dimensions are not suported: [<INVALID_DIMENSIONS>]"
    ],
    "status": "INVALID_ARGUMENT"
}

If you provide an invalid JSON request body, you'll receive an INVALID_REQUEST response:

{
    "code": 400,
    "requestId": "a0b12345-6c78-90123-4def-ghij56789012",
    "details": [
        "could not decode body: <MESSAGE>"
    ],
    "status": "INVALID_REQUEST"
}

500

If there is a backend error, you'll receive an INTERNAL error response:

{
    "code": 500,
    "requestId": "",
    "details": [],
    "status": "INTERNAL"
}

As the error details are internal, we won't include them in the response.

Supported request values

Here, you'll find the available values for the metrics, dimensions, and filters request fields.

Supported metrics

[
  "churnRate",
  "usersOfStepOne"
]

Supported dimensions

[
    "eventDimension[jt_level_name]",
]

Supported dimension filters

[
    "app",
    "campaign.id",
    "country",
    "installAppVersionName",
    "installAppVersionCode",
    "eventDimension[jt_level_name]",
]