> For the complete documentation index, see [llms.txt](https://docs.mediarithmics.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mediarithmics.io/api-reference/userpoint/userpoint-analytics.md).

# Userpoint Analytics

Operations related to **UserPoint Analytics**, the programmatic access to user activity data through data cube APIs for reporting and analysis:

* **Metrics** - Active users, sessions, conversions, revenue, avg session duration, conversion rate
* **Dimensions** - Date (daily/hourly), channel\_id, campaign, activity type, referrer
* **Report types** - Activities analytics, usage reports, collection volumes, event ingestion monitoring
* **Capabilities** - Date ranges, filter clauses, metric aggregations, dimension grouping

Results leverage the multi-model database with \~1 second response time for the latest 4 months of data.

Relevant documentation:

* [Activities analytics queries](https://developer.mediarithmics.io/querying-your-data/activities-analytics-queries)
* [Data cubes](https://developer.mediarithmics.io/resources/data-cubes)

## POST /datamarts/{datamart\_id}/user\_activities\_funnel

> Fetch users activities funnel

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Userpoint Analytics","description":"Operations related to **UserPoint Analytics**, the programmatic access to user activity data through data cube APIs for reporting and analysis:\n- **Metrics** - Active users, sessions, conversions, revenue, avg session duration, conversion rate\n- **Dimensions** - Date (daily/hourly), channel_id, campaign, activity type, referrer\n- **Report types** - Activities analytics, usage reports, collection volumes, event ingestion monitoring\n- **Capabilities** - Date ranges, filter clauses, metric aggregations, dimension grouping\n\nResults leverage the multi-model database with ~1 second response time for the latest 4 months of data.\n\nRelevant documentation:\n- [Activities analytics queries](https://developer.mediarithmics.io/querying-your-data/activities-analytics-queries)\n- [Data cubes](https://developer.mediarithmics.io/resources/data-cubes)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/user_activities_funnel":{"post":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/GroupedFunnelOutputBody"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"getUsersActivitiesFunnel","summary":"Fetch users activities funnel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FunnelRequestBody"}}},"required":true},"parameters":[{"schema":{"type":"string"},"name":"datamart_id","required":true,"explode":false,"in":"path","style":"simple"}],"tags":["Userpoint Analytics"],"description":""}}},"components":{"schemas":{"GroupedFunnelOutputBody":{"type":"object","properties":{"global":{"$ref":"#/components/schemas/FunnelOutputBody"},"grouped_by":{"type":"array","items":{"$ref":"#/components/schemas/FieldValueFunnelOutputBody"},"readOnly":false}},"required":["global","grouped_by"]},"FunnelOutputBody":{"allOf":[{"$ref":"#/components/schemas/FunnelComputation"},{"type":"object","properties":{"total":{"type":"integer","format":"int32","default":0,"readOnly":false},"steps":{"type":"array","items":{"$ref":"#/components/schemas/FunnelStep"},"readOnly":false}},"required":["steps","total"]}]},"FunnelComputation":{"type":"object"},"FunnelStep":{"type":"object","properties":{"count":{"type":"integer","format":"int64","default":0,"readOnly":false},"amount":{"type":"number","format":"float","default":0,"readOnly":false},"name":{"type":"string","readOnly":false},"interaction_duration":{"type":"integer","format":"int64","default":0,"readOnly":false},"conversion":{"type":"integer","format":"int32","default":0,"readOnly":false}},"required":["count","interaction_duration","name"]},"FieldValueFunnelOutputBody":{"type":"object","properties":{"dimension_names":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false},"dimension_values":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false},"funnel":{"$ref":"#/components/schemas/FunnelOutputBody"},"dimension_decorator":{"type":"string","readOnly":false}},"required":["dimension_names","dimension_values","funnel"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]},"FunnelRequestBody":{"type":"object","properties":{"for":{"type":"array","items":{"$ref":"#/components/schemas/FunnelStepFilter"},"readOnly":false},"number_of_parts_to_split_on":{"type":"integer","format":"int32","default":0,"readOnly":false},"limit":{"type":"integer","format":"int32","default":0,"readOnly":false},"in":{"$ref":"#/components/schemas/TimeRange"},"group_by":{"type":"string","readOnly":false}},"required":["for","in"]},"FunnelStepFilter":{"type":"object","properties":{"group_by_dimension":{"type":"string","readOnly":false},"max_days_after_previous_step":{"type":"integer","format":"int32","default":0,"readOnly":false},"group_by_dimensions":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false},"name":{"type":"string","readOnly":false},"filter_clause":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/BooleanOperator"},"filters":{"type":"array","items":{"$ref":"#/components/schemas/DimensionFilter"},"readOnly":false}},"readOnly":false,"required":["filters","operator"]}},"required":["filter_clause","group_by_dimensions","name"]},"BooleanOperator":{"type":"string","enum":["OR","AND"],"readOnly":false},"DimensionFilter":{"allOf":[{"$ref":"#/components/schemas/Filter"},{"type":"object","properties":{"dimension_name":{"type":"string","readOnly":false},"case_sensitive":{"type":"boolean","default":false,"readOnly":false},"expressions":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false},"operator":{"$ref":"#/components/schemas/DimensionFilterOperator"},"not":{"type":"boolean","default":false,"readOnly":false}},"required":["dimension_name","expressions","operator"]}]},"Filter":{"type":"object"},"DimensionFilterOperator":{"type":"string","enum":["EXACT","NUMERIC_EQUAL","NUMERIC_GREATER_THAN","NUMERIC_LESS_THAN","IN_LIST","IS_NULL","LIKE"],"readOnly":false},"TimeRange":{"discriminator":{"propertyName":"type","mapping":{"WINDOW":"#/components/schemas/TimeRangeWindow","DATES":"#/components/schemas/TimeRangeDates"}},"oneOf":[{"$ref":"#/components/schemas/TimeRangeWindow"},{"$ref":"#/components/schemas/TimeRangeDates"}],"properties":{"type":{"type":"string","enum":["WINDOW","DATES"]}},"required":["type"]},"TimeRangeWindow":{"type":"object","properties":{"offset":{"type":"integer","format":"int32","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimeUnit"}},"required":["offset","unit"]},"TimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"readOnly":false},"TimeRangeDates":{"type":"object","properties":{"start_date":{"$ref":"#/components/schemas/LocalDateTime"},"end_date":{"$ref":"#/components/schemas/LocalDateTime"},"timezone":{"type":"string","readOnly":false}},"required":["end_date","start_date"]},"LocalDateTime":{"type":"string","format":"date-time","description":"iso8601 date time"}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/user\_activities\_analytics

> Fetch users analytics

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Userpoint Analytics","description":"Operations related to **UserPoint Analytics**, the programmatic access to user activity data through data cube APIs for reporting and analysis:\n- **Metrics** - Active users, sessions, conversions, revenue, avg session duration, conversion rate\n- **Dimensions** - Date (daily/hourly), channel_id, campaign, activity type, referrer\n- **Report types** - Activities analytics, usage reports, collection volumes, event ingestion monitoring\n- **Capabilities** - Date ranges, filter clauses, metric aggregations, dimension grouping\n\nResults leverage the multi-model database with ~1 second response time for the latest 4 months of data.\n\nRelevant documentation:\n- [Activities analytics queries](https://developer.mediarithmics.io/querying-your-data/activities-analytics-queries)\n- [Data cubes](https://developer.mediarithmics.io/resources/data-cubes)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/user_activities_analytics":{"post":{"requestBody":{"description":"The document import to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportRequestBody"}}},"required":true},"operationId":"getUsersAnalytics","description":"","summary":"Fetch users analytics","parameters":[{"schema":{"type":"string"},"required":true,"name":"datamart_id","style":"simple","explode":false,"in":"path"}],"tags":["Userpoint Analytics"],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/Report"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"schemas":{"ReportRequestBody":{"type":"object","properties":{"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/Dimension"},"readOnly":false},"sample_factor":{"type":"integer","format":"int32","default":0,"readOnly":false},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/Metric"},"readOnly":false},"dimension_filter_clauses":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/BooleanOperator"},"filters":{"type":"array","items":{"$ref":"#/components/schemas/DimensionFilter"},"readOnly":false}},"readOnly":false,"required":["filters","operator"]},"order_by":{"$ref":"#/components/schemas/OrderBy"},"max_result":{"type":"integer","format":"int32","default":0,"readOnly":false},"metric_filter_clauses":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/BooleanOperator"},"filters":{"type":"array","items":{"$ref":"#/components/schemas/MetricFilter"},"readOnly":false}},"readOnly":false,"required":["filters","operator"]},"first_result":{"type":"integer","format":"int32","default":0,"readOnly":false},"date_ranges":{"type":"array","items":{"$ref":"#/components/schemas/DateRange"},"readOnly":false}},"required":["date_ranges","dimensions","metrics"]},"Dimension":{"type":"object","properties":{"name":{"type":"string","readOnly":false}},"required":["name"]},"Metric":{"type":"object","properties":{"expression":{"type":"string","readOnly":false},"alias":{"type":"string","readOnly":false},"formatting_type":{"$ref":"#/components/schemas/FormattingType"}},"required":["expression"]},"FormattingType":{"type":"string","enum":["INTEGER","FLOAT","TIME","PERCENT"],"readOnly":false},"BooleanOperator":{"type":"string","enum":["OR","AND"],"readOnly":false},"DimensionFilter":{"allOf":[{"$ref":"#/components/schemas/Filter"},{"type":"object","properties":{"dimension_name":{"type":"string","readOnly":false},"case_sensitive":{"type":"boolean","default":false,"readOnly":false},"expressions":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false},"operator":{"$ref":"#/components/schemas/DimensionFilterOperator"},"not":{"type":"boolean","default":false,"readOnly":false}},"required":["dimension_name","expressions","operator"]}]},"Filter":{"type":"object"},"DimensionFilterOperator":{"type":"string","enum":["EXACT","NUMERIC_EQUAL","NUMERIC_GREATER_THAN","NUMERIC_LESS_THAN","IN_LIST","IS_NULL","LIKE"],"readOnly":false},"OrderBy":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false},"sort_order":{"$ref":"#/components/schemas/SortBy"}},"required":["field_name"]},"SortBy":{"type":"string","enum":["ASCENDING","DESCENDING"],"readOnly":false},"MetricFilter":{"allOf":[{"$ref":"#/components/schemas/Filter"},{"type":"object","properties":{"metric_name":{"type":"string","readOnly":false},"not":{"type":"boolean","default":false,"readOnly":false},"operator":{"$ref":"#/components/schemas/MetricFilterOperator"},"comparison_value":{"type":"string","readOnly":false}},"required":["comparison_value","metric_name","operator"]}]},"MetricFilterOperator":{"type":"string","enum":["EQUAL","GREATER_THAN","LESS_THAN"],"readOnly":false},"DateRange":{"type":"object","properties":{"start_date":{"type":"string","readOnly":false},"end_date":{"type":"string","readOnly":false},"timezone":{"type":"string","readOnly":false}},"required":["end_date","start_date"]},"Report":{"oneOf":[{"type":"object","properties":{"report_view":{"$ref":"#/components/schemas/ReportView"}},"required":["report_view"]}]},"ReportView":{"type":"object","properties":{"items_per_page":{"type":"integer","format":"int32","default":0,"readOnly":false},"total_items":{"type":"integer","format":"int32","default":0,"readOnly":false},"columns_headers":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false},"rows":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/Any"},"readOnly":false},"readOnly":false}},"required":["columns_headers","items_per_page","rows","total_items"]},"Any":{"type":"object"},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/user\_activities\_analytics/dimensions

> Fetch users activities analytics dimensions

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Userpoint Analytics","description":"Operations related to **UserPoint Analytics**, the programmatic access to user activity data through data cube APIs for reporting and analysis:\n- **Metrics** - Active users, sessions, conversions, revenue, avg session duration, conversion rate\n- **Dimensions** - Date (daily/hourly), channel_id, campaign, activity type, referrer\n- **Report types** - Activities analytics, usage reports, collection volumes, event ingestion monitoring\n- **Capabilities** - Date ranges, filter clauses, metric aggregations, dimension grouping\n\nResults leverage the multi-model database with ~1 second response time for the latest 4 months of data.\n\nRelevant documentation:\n- [Activities analytics queries](https://developer.mediarithmics.io/querying-your-data/activities-analytics-queries)\n- [Data cubes](https://developer.mediarithmics.io/resources/data-cubes)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/user_activities_analytics/dimensions":{"get":{"operationId":"getUsersActivitiesAnalyticsDimensions","description":"","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/DatamartUsersAnalyticsDimensionList"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["Userpoint Analytics"],"parameters":[{"in":"path","style":"simple","explode":false,"schema":{"type":"string"},"required":true,"name":"datamart_id"},{"schema":{"type":"boolean"},"style":"form","explode":true,"required":false,"in":"query","name":"is_available_for_funnel"}],"summary":"Fetch users activities analytics dimensions"}}},"components":{"schemas":{"DatamartUsersAnalyticsDimensionList":{"type":"object","properties":{"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/DatamartUsersAnalyticsDimensionResource"},"readOnly":false}},"required":["dimensions"]},"DatamartUsersAnalyticsDimensionResource":{"type":"object","properties":{"label":{"type":"string","readOnly":false},"value":{"type":"string","readOnly":false}},"required":["label","value"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.mediarithmics.io/api-reference/userpoint/userpoint-analytics.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.