UserActivity API

The user activities endpoint gives you the ability to retrieve & delete any activities (and attached events) on a given UserPoint.

Retrieve activities & events from a UserPoint

GET https://api.mediarithmics.com/v1/datamarts/:datamartId/user_timelines/:userpointId/user_activities?filters=:filters

Path Parameters

Name
Type
Description

datamartId*

String

The ID of the datamart want to retrieve activities for

userpointId*

String

The ID of the UserPoint you want to retrieve activities for

Query Parameters

Name
Type
Description

filters

String

Filter(s) to select appropriat user activities

{
    // Response
}

Delete activities & events from a UserPoint

DELETE https://api.mediarithmics.com/v1/datamarts/:datamartId/user_timelines/:userpointId/user_activities?filters=:filters

Path Parameters

Name
Type
Description

datamartId*

String

The ID of the datamart want to retrieve activities for

userpointId*

String

The ID of the UserPoint you want to retrieve activities for

Query Parameters

Name
Type
Description

filters

String

Filter(s) to select appropriat user activities

Filters

As mentionned above, filters are optional and give you the ability to narrow your query. You can apply filters on any custom fields you have in your activity object as well as the following proprietary fields:

  • $unique_key

  • $type

  • $channel_id

  • $ts (through start_ts & end_ts keywords)

To apply any filter, mention the field on which you want your filter to be applied, followed by double equal (==), then by value(s) for the field to be matched against.

Note that:

  • You can provide in your query multiple filters by seperating filters with a comma (,). In that case, it will be considered as an "AND" between those filters

  • A filter can take multiple values by separating values with a pipe (|). In that case, it will be considered as an "OR" between those values

Query examples

Last updated

Was this helpful?