Creating a report

Search…
Creating a report
This is an overview of the activities analytics capabilities.
Report
Reports returned by the API are a ReportView object in a Single resource wrapper. The result table is made up of headers and rows, with dimensions and metrics. The following report view is a table with two dimensions (day and channel ID) and two metrics (users and number of transactions).
1
"report_view": {
2
    "columns_headers": [
3
                "date_yyyy_mm_dd",
4
                "channel_id",
5
                "users",
6
                "number_of_transactions"
7
            ],
8
    // Data
9
    "rows": [
10
        [
11
            "2021-10-10",
12
            666,
13
            3881,
14
            17800.0
15
        ],
16
        [
17
            "2021-10-10",
18
            555,
19
            1838,
20
            4200.0
21
        ],
22
        [
23
            "2021-10-11",
24
            666,
25
            532,
26
            3900.0
27
        ],
28
        [
29
            "2021-10-11",
30
            555,
31
            8,
32
            100.0
33
        ]
34
        // ...[
35
    ]
36
}
Copied!
date_yyyy_mm_dd
channel_id
users
number_of_transactions
2021-10-10
666
3881
17800
2021-10-10
555
1838
4200
2021-10-11
666
532
3900
Report request
To use any data dube endpoint, you can build a report request object. Main parameters to start with are : 
A valid entry in the date_ranges field
At least one valid entry in the metrics field if you want to measure anything and not just get possible values of a dimension
At least one valid entry in the dimensions field if you want to get the possible values of a dimension or calculate metrics for different dimensions.
post
https://api.mediarithmics.com
/v1/datamarts/:datamartId/user_activities_analytics
Minimal object to start with
1
{
2
    "date_ranges": [
3
        {
4
            "start_date": "2021-10-10T00:00:00",
5
            "end_date": "2021-10-25T23:59:59"
6
        }
7
    ],
8
    "dimensions": [
9
        {
10
            "name": "date_yyyy_mm_dd"
11
        }
12
    ],
13
    "metrics": [
14
        {
15
            "expression": "users"
16
        }
17
    ]
18
}
Copied!
Dimensions
Dimensions describe and group data. The channel_id dimension, for example, indicates the channel on which the activity was registered. You can specify zero or more dimensions. See the documentation of each data cube for a complete list of available dimensions.
For example, this request groups active users by channel, day and type of device in activities analytics data cube.
1
"dimensions": [
2
    {
3
        "name": "date_yyyy_mm_dd"
4
    },
5
    {
6
        "name": "channel_id"
7
    },
8
    {
9
        "name": "device_form_factor"
10
    }
11
]
12
"metrics": [
13
    {
14
        "expression": "users"
15
    }
16
]
Copied!
Metrics
Metrics are calculated on your data, for the specified date range and for each requested dimension. You can specify zero or more metrics. Specifying zero metrics usually means that you are only interested in the possible values of a dimension. See the documentation of each data cube for a complete list of available metrics.
This request will show three metrics, grouped per day.
1
"dimensions": [
2
    {
3
        "name": "date_yyyy_mm_dd"
4
    }
5
]
6
"metrics": [
7
    {
8
        "expression": "users"
9
    },
10
    {
11
        "expression": "sessions"
12
    },
13
    {
14
        "expression": "revenue"
15
    }
16
]
Copied!
Pagination
You can only get the first page of a report at the moment.
The ReportView returned object contains two properties : 
1
"report_view": {
2
    "items_per_page": int,
3
    "total_items": int,
4
    ...
5
}
Copied!
items_per_page is the page size (always 100 right now) and total_items is the number of returned items (between zero and items_per_page as only the first page can be retrieved).
Tip : you should usually find workarounds to not use a real pagination system.
For example, if you want the number of sessions per day on the last four months, you know you will have 122 days in the result which can't be retrieved by a single request. You then do two requests, one for the two first months and one for the others, and you don't need a pagination.
Dimension filters
You can ask to retrieve data only for specific dimension values. For example, to calculate the revenue for a specific channel, or to only look at activities with transactions. To filter dimensions, specify a FilterClause in your request object. It contains an operator and one or more DimensionFilter.
In this example, the metrics are only calculated for activities of type SITE_VISIT or DISPLAY_AD on channel 666
1
 "dimension_filter_clauses": {
2
        "operator": "AND",
3
        "filters": [
4
            {
5
                "dimension_name": "type",
6
                "operator": "IN_LIST",
7
                "not": false,
8
                "expressions": [
9
                    "SITE_VISIT", "DISPLAY_AD"
10
                ]
11
            },
12
            {
13
                "dimension_name": "channel_id",
14
                "operator": "EXACT",
15
                "not": false,
16
                "expressions": [
17
                    "666"
18
                ]
19
            }
20
        ]
21
    }
Copied!
Date ranges
You can only retrieve data for one specific date range. The format is ready to be able to query multiple date ranges in the future.
1
"date_ranges": [
2
    {
3
        "start_date": "2021-10-10T00:00:00",
4
        "end_date": "2021-10-25T23:59:59"
5
    }
6
]
Copied!
There is no way to calculate relative date ranges with dates like now-7d at the moment.
Order by
You can specify which metrics to order by.
1
  // Order by the number of users, in ascending order
2
  "order_by": {
3
    "field_name": "users"
4
  }
5
  
6
 // Order by the number of users, in descending order
7
  "order_by": {
8
    "field_name": "-users"
9
  },
Copied!
​
Next step
Now that we have covered the basics of reports, you can take a look at our sample Use cases to have better ideas of what you can achieve.