Events ingestion monitoring

This page shows you how to start using the events ingestion monitoring API.

When we collect activities, we track the number of events that go through each step of the mediarithmics data pipeline.

This API is a mediarithmics Data cube and works similarly to Activities analytics queries API.

Quickstart

POST https://api.mediarithmics.com/v1/platform_monitoring/data_ingestion

Request Body

Name	Type	Description
metrics*	array	Array of Metric to retrieve.
dimension_filter_clauses	object	Filters to apply on dimensions before calculating the metric. For more information, see FilterClause.
dimensions*	Dimensions	Dimensions to group metrics by.
date_ranges	array	Periods to analyze. Each date range is an object with a start_date and an end_date. See DateRange.

200: OK

{
    // Response
}

Here is a sample report request body payload with all the important properties:

{
    // Retrieve the data in the specified date range
    // Mandatory
    // Tip : you can use relative date formats such as "now-7d/d"
    "date_ranges": [
        {
            "start_date": "2021-10-10T00:00:00",
            "end_date": "2021-10-25T23:59:59"
        }
    ],
    // List of dimensions to retrieve
    "dimensions": [
        {
            "name": "date_time"
        },
        {
            "name": "datamart_id"
        },
        {
            "name": "pipeline_step"
        }
    ],
    // List of metrics to retrieve
    "metrics": [
        {
            "expression": "event_count"
        }
    ]
}

Available pipeline steps

We monitor the number of events that reach the given ingestion steps:

Step	Description
JS_TAG	Measure the number of events sent by the mediarithmics Javascript TAG
API	Measure the number of events sent through the ingestion API api.mediarithmics.com/v1/datamarts/{datamart_id}/user_activities
DOCUMENT_IMPORT	Measure the number of events sent through the USER_ACTIVITY imports with the document import feature
EVENT_RULES	Measure the number of events that match configures rules
ACTIVITY_ANALYZER	Measure the number of events that pass through activity analyzer plugins
DOCUMENT_STORE	Measure the number of events that are stored in the mediarithmics platform.

Retention

These aggregated stats are kept for 3 months.

Supported dimensions and metrics

See Dimensions and metrics for the complete list of supported dimensions and metrics.

Learning more about data cubes

This endpoint is a mediarithmics Data cube. You can find documentation on how data cubes work and which data cubes are availables in the specific documentation section.