Collection volumes
Last updated
Last updated
This page shows you how to get started using the collection volumes mediarithmics API to query the number of elements indexed in mediarithmics.
For each datamart collection, you can get the number of elements which were indexed at a given time.
This API is a mediarithmics Data cube and works similarly as Activities analytics queries API.
POST
https://api.mediarithmics.com/v1/platform_monitoring/collections
Name | Type | Description |
---|---|---|
Here is a sample report request body payload with all the important properties:
Collection counts are retrieved every day through OTQL queries, for each indexed collection. A collection is indexed if it is in your schema. Volumes for non indexed collections are not computed. For more information on collections indexing, see Data model.
Hereunder is a description of the queries we use to compute the volumes.
The OTQL query is automatically adapted in case the runtime schema is using the @Mirror directive.
These aggregated stats are kept for two years.
See Dimensions and metrics for the complete list of supported dimensions and metrics.
This endpoint is a mediarithmics Data cube. You can find documentation on how data cubes work and which are available in the specific documentation section.
Collection name | OTQL query |
---|---|
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.
UserPoint
SELECT @count{} FROM UserPoint
UserAccount
SELECT @count{} FROM UserAccount
UserEmail
SELECT @count {} FROM UserEmail
UserAgent
SELECT @count {} FROM UserAgent
UserProfile
SELECT @count {} FROM UserProfile
UserActivity
SELECT @count {} FROM UserActivity
UserEvent
SELECT @count {} FROM UserEvent
UserSegment
SELECT @count {} FROM UserSegment
UserChoice
SELECT @count {} FROM UserChoice
UserScenario
SELECT @count {} FROM UserScenario