Request to create report

Create a request to export report.

Input data

POST https://tracker.my.com/api/report/v1/file/create.json

Parameters

To get data for multiple filters, use square brackets 'idApp[]': [1, 2, 3] or separate values by commas 'idApp': '1,2,3'.

* — required parameters

Example query

To prevent errors in the report, we recommend completing each query with the next set of selectors (values are given for example):

&settings[idCurrency]=840&settings[tz]=America%2FChicago&settings[precision]=2&settings[retIndent]=3600

Filter by dates

Report for the period from 10-07-2020 to 17-10-2020 with the number of installations countInstall for applications idApp.

settings[filter][date][from]=2020-07-10&settings[filter][date][to]=2020-07-17&settings[selectors]=idApp,countInstall&settings[idCurrency]=840&settings[tz]=America%2FChicago&settings[precision]=2&settings[retIndent]=3600

Filter by apps

Report for the period from 10-07-2020 to 17-10-2020 with the number of installations countInstall for applications idApp: 1234 и 431.

settings[filter][date][from]=2020-07-10&settings[filter][date][to]=2020-07-17&settings[selectors]=idApp,countInstall&settings[filter][dimension][idApp][value][]=1234&settings[filter][dimension][idApp][value][]=4311&settings[idCurrency]=840&settings[tz]=America%2FChicago&settings[precision]=2&settings[retIndent]=3600

Group by apps

Report for the period from 10-07-2020 to 17-10-2020 with the number of installations countInstall for applications idApp and projects idProject.

settings[filter][date][from]=2020-07-10&settings[filter][date][to]=2020-07-17&settings[selectors]=idApp,idProject,countInstall&settings[groupBy]=idApp&settings[idCurrency]=840&settings[tz]=America%2FChicago&settings[precision]=2&settings[retIndent]=3600

Filter by params

Report for the period from 10-07-2020 to 17-10-2020 with the number of installations countInstall for applications idApp with filter by event parameters name1=val1 and name2>22 with [target]=events.

settings[filter][date][from]=2020-07-10&settings[filter][date][to]=2020-07-17&settings[selectors]=idApp,countInstall&settings[filter][dimension][params][name][]=name1&settings[filter][dimension][params][cmp][]=equals&settings[filter][dimension][params][value][]=val1&settings[filter][dimension][params][name][]=name2&settings[filter][dimension][params][cmp][]=>&settings[filter][dimension][params][value][]=22&settings[filter][dimension][params][target]=events&settings[filter][dimension][params][join]=and&settings[idCurrency]=840&settings[tz]=America%2FChicago&settings[precision]=2&settings[retIndent]=3600

Filter by versions

Report with filter by the app versions: 1.2 and 3.4.5.

settings[filter][dimension][appVersion][operator][]=%3D&settings[filter][dimension][appVersion][major][]=1&settings[filter][dimension][appVersion][minor][]=2&settings[filter][dimension][appVersion][patch][]=&settings[filter][dimension][appVersion][operator][]=%3D&settings[filter][dimension][appVersion][major][]=3&settings[filter][dimension][appVersion][minor][]=4&settings[filter][dimension][appVersion][patch][]=5&settings[idCurrency]=840&settings[tz]=America%2FChicago&settings[precision]=2&settings[retIndent]=3600

Responses

Success

A 200 status code indicates success. It will include an identifier of a new request in the idReportFile field.

{
  "code": 200,
  "message": "Ok",
  "data": {
    "idReportFile": "2"
  }
}

Errors

A 400 status code indicates an error in parameters given. For example:

• Invalid file type

  {
    "code": 400,
    "message": "Bad Request",
    "data": {
      "error": {
        "detail": "Argument 'fileType' must be in set of file types. Allowed values are: xlsx, csv."
      }
    }
  }

• Missing parameter

  {
    "code": 400,
    "message": "Bad Request",
    "data": {
      "error": {
        "detail": "Argument 'settings' is expected but not set"
      }
    }
  }

• Invalid selector

  {
    "code": 400,
    "message": "Bad Request",
    "data": {
      "error": {
        "detail": "Argument 'settings[selectors]' is invalid"
      }
    }
  }

Restrictions

• A 403 status code indicates that the method needs authorization. Maybe you made mistakes or forgot to send authorization data.

  {
    "code": 403,
    "message": "Access denied",
    "data": null
  }

• A 400 status code is returned when you sent a new request and exceeded the limit of request in a queue:

  {
    "code": 400,
    "message": "Bad Request",
    "data": {
      "error": {
        "detail": "Maximum number of simultaneous requests reached. Wait until there is space available in the queue.",
        "info": {
          "reportFiles": [
            {
              "idReportFile": "2"
            }
          ]
        }
      }
    }
  }