Resources usage

This page shows you how to get started using the resources usage mediarithmics API.

Each datamart resource (segments, exports, imports...) that lead to write or read access on mediarithmics platform are tracked and their consumption are measured.

Thanks to this API you can get a report of your datamart consumption that match:

• the cost of each query executed on the platform

• the amount of data ingested

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

Quickstart

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

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 to group metrics by.	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

{
    "status": "ok",
    "data": {
        "report_view": {
            "items_per_page": 100,
            "total_items": 7,
            "columns_headers": [
                "date_time",
                "datamart_id",
                "collection",
                "count"
            ],
            "rows": [
                [
                    1637931755000,
                    9999,
                    "USER_POINT",
                    100
                ],
                [
                    1637931755100,
                    9999,
                    "USER_EVENT",
                    50
                ]
            ]
        }
    }
}

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

{
    // Retrieve the data in the specified date range
    // Mandatory
    "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": "community_id"
        },
        {
            "name": "source"
        }, 
        {
            "name": "scan_cost"
        }
    ],
    // Filters on dimensions
    "dimension_filter_clauses": {
        "operator": "AND",
        "filters": [
            {
                "dimension_name": "community_id",
                "operator": "EXACT",
                "expressions": [
                    100
                ]
            }
        ]
    },
    // List of metrics to retrieve
    "metrics": [
        {
            "expression": "scan_cost"
        }
    ]
}

Retention

These aggregated stats are kept for two years.

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 available in the specific documentation section.