IntegracjeDane tabelaryczne

Receiving tabular data

Tabular data are most versatile since they allow you to form any report from various perspectives.

Request format #

To get tabular data, execute the GET request:

GET https://content.mql5.com/api/v1/reports/website/{WEBSITE_ID}/table
 ?metrics=<string>
 &date_from=<unixtime>
 &date_to=<unixtime>
 &group=<string>
 &where=<array>
 &offset=<integer>
 &limit=<integer>
 &order=<string>

Set the website ID as {WEBSITE_ID}. It can be obtained in the website settings (ID field) of the Finteza panel.

Request parameters #

Parameter

Type

Description

metrics *

string

List of metrics (comma-separated), for example, metrics=visits,events.

date_from *

unixtime

Data request initial date. Specified in seconds since 1970.01.01, for example, date_from=1549027860.

date_to *

unixtime

Data request end date. Specified in seconds since 1970.01.01, for example, date_from=1549027860.

group *

string

List of fields for arranging data (comma-separated).

where

array

Array of conditions in the form ?where[key]=value, where the key is a name of the field sorting is to be based on. The following operators can be used for the condition value:

  • = (IS) — exact value match. For example, where[os]=windows means that only data on Windows OS users are to be returned.
  • * (LIKE) — inexact value match. For example, where[device]=*mobile means that only data on users whose device type contains "mobile" are to be returned.
  • ! (NOT) — value mismatch. For example, where[country]=*!ru means that only data for non-Russian users are to be returned.

offset

integer

Position of the first list item you need to receive data from. The default is 0 — receive data from the most recent (last) element.

limit

integer

Number of list items to be received. The default is 20.

order

string

Name of the field sorting is to be based on. To reverse the sorting, set "-" before the field name, for example, order=-visits.

* — required parameters.

Sample request #

GET https://content.mql5.com/v1/reports/website/dxnnhxrwpcwsgwowveipxmslrznjfhzarp/table
 ?metrics=webvisits,events
 &group=ua_device,ua_device_model
 &where[os]=windows
 &where[device]=*mobile
 &where[country]=!ru
 &offset=0
 &limit=20
 &date_from=1549027860
 &date_to=1549632660
 &order=webvisits

Sample response #

{
    "data": {
        "offset": 0,
        "limit": 20,
        "date_from": 1549027860,
        "date_to": 1549632660,
        "where": {
            "os""windows",
            "device""*mobile",
            "country""!ru",
        },
        "order""webvisits",
        "items": [ {
            "ua_device""Desktop",
            "ua_device_model""Apple",
            "webvisits": 4205748,
            "events": 1247138
        }, {
            "ua_device""Mobile",
            "ua_device_model""Apple",
            "webvisits": 42050,
            "events": 1247
        }, {
            "ua_device""Tablet",
            "ua_device_model""Apple",
            "webvisits": 420,
            "events": 12
        } ]
    }
}