Log in

Request to export raw data

Create a request to export raw data to CSV files.

Input data

POST https://tracker.my.com/api/raw/v1/export/create.json

Parameters

Name Value Description Note
idApp Some available app ids, separated by commas or array-based

You can find idApp in the URL of your app page

For example: 1,454,23 or
idApp[]=1&idApp[]=454&idApp[]=23
Filter by app id When you use idApp and SDKKey filters simultaneously, you get data that meet at least one condition
SDKKey Some available SDK keys, separated by commas or array-based

For example: 00004399666566289449,
00004399666566289448
Filter by SDK keys
idAccount Some available account ids, separated by commas or array-based

For example: 3,6
Filter by account id
idAd Some available tracking link ids, separated by commas or array-based

For example: 87877,464746
Filter by tracking link id
idCampaign Some available campaign ids, separated by commas or array-based

For example: 66,14
Filter by campaign id
idCountry Some values from the Countries dictionary, separated by commas or array-based

For example: 188,200
Filter by country id
idProject Some available project ids, separated by commas or array-based

For example: 234,456
Filter by project id
isVerified One value from the Verification dictionary

For example: 1
Filter by verification Only for events payments, userPayments, testPayments, trialPayments, and userTrialPayments
idPurchaseType One value from the Purchase types dictionary

For example: 1
Filter by purchase types Only for events payments, userPayments, testPayments, trialPayments, and userTrialPayments
eventName Values array

For example: eventName[]=name1&eventName[]=
name2&eventName[]=name3
Filter by custom event name Only for events customEvents, userCustomEvents
eventNameInvert One of the values:
0 — off (by default)
1 — on
Invert the eventName filter (exclude specified custom events from export) Only for events customEvents and userCustomEvents
event * One value from the Events dictionary

For example: installs
Event type
selectors * Some values from the Selectors dictionary, separated by commas or array-based

For example: idApp,idCountry
Field list for export
dateFrom ** Date

For example: 2020-12-17
Filter by date, from which the export begins Cannot be less than 1970-01-01;
cannot be more than the current date;
must not be more than dateTo;
use with the timezone parameter to set the correct timezone (Europe/Moscow, by default)
dateTo ** Date

For example: 2020-12-31
Filter by date to which the export complete Cannot be more than the current date;
must not be less than dateFrom;
use with the timezone parameter to set the correct timezone (Europe/Moscow, by default)
tsFrom ** Timestamp

For example: 1514822000
Filter by event timestamp from which the export begins Cannot be more than the current timestamp;
must not be more than tsTo
tsTo ** Timestamp

For example: 1515132000
Filter by event timestamp to which the export complete Cannot be more than the current timestamp;
must not be less than tsFrom
availabilityTsFrom timestamp

For example: 1514822000
Filter by timestamp of event appearance in the system, from which the export begins Must be less than the current timestamp minus 3 hours;
must not be more than availabilityTsTo
availabilityTsTo timestamp

For example: 1515132000
Filter by timestamp of event appearance in the system to which the export complete Must be less than the current timestamp minus 3 hours;
must not be less than availabilityTsFrom
rooted One value from the Root/Jailbreak dictionary

For example: 2
indicates whether Jailbreak or root access has been detected on the device.

Jailbreak refers to the iOS, while root access refers to Android

timezone One value from the Timezones dictionary

For example: Asia/Yekaterinburg
Time zone for dates interpretation The timezone Europe/Moscow is set by default
idAdMediator One value from the Ad mediators dictionary

For example: 1
Filter by ad mediator Only for events adMonetization and userAdMonetization
idSegment ID of one of the segments available to you

For example: 2
Filter by segment ID Only for events hits and installs
idPartner Some available partner ids, separated by commas or array-based

For example: 234,456
Filter by partner id

* — required parameters

* — require at least one pair of parameters: dateFrom and dateTo or tsFrom and tsTo

Example query

Use the create method to export payments data from 2017-11-02 to 2017-11-30 in the Europe/Moscow timezone with the selectors:

/api/raw/v1/export/create.json?event=payments&selectors=idCountry,waid,idAccount,iosVendorId&dateTo=2017-11-30&dateFrom=2017-11-02&timezone=Europe/Moscow

Responses

Success

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

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

Errors

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

  • Invalid event type
    {
      "code": 400,
      "message": "Bad Request",
      "data": {
        "error": {
          "detail": "Argument 'event' must be in set of allowed tables. Allowed values are: install, payment, launch, customEvent."
        }
      }
    }
  • Missing parameter
    {
      "code": 400,
      "message": "Bad Request",
      "data": {
        "error": {
          "detail": "Argument 'event' is expected but not set"
        }
      }
    }
  • Invalid selector.
    {
      "code": 400,
      "message": "Bad Request",
      "data": {
        "error": {
          "detail": "Argument 'selectors' is invalid"
        }
      }
    }
  • Raw data cannot be exported from an account because export permissions are not granted to a user.
    {
      "code": 400,
      "message": "Bad Request",
      "data": {
        "error": {
          "detail": "Export permissions required to export raw data from an account"
        }
      }
    }

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": {
            "exports": [
              {
                "idRawExport": "2"
              }
            ]
          }
        }
      }
    }
  • A 400 status code is returned when a maximum of values exceeds in a filter. A request has a length limit that means that in one filter, you can pass a maximum of 1000 values. If you have several filters, then you can pass a maximum of 1000 values in each.
    {
      "code": 400,
      "message": "Bad Request",
      "data": {
        "error": {
          "detail": "Argument 'idCampaign' set size expected to be below 1000",
        }
      }
    }
Was this article helpful?