For the complete documentation index, see llms.txt. This page is also available as Markdown.

User Data Stream (sharing)

Operations related to User Data Streams for streaming all content and identifiers collected in a source Datamart to a destination Datamart in real-time. Enables cross-datamart data sharing and multi-organization data flows while maintaining data integrity, supporting use cases like data consolidation, partner data sharing, and multi-brand data aggregation.

Search user datastream subscriptions

get
/datamarts/{datamart_id}/user_data_stream_subscriptions
Path parameters
datamart_idinteger · int64Required
Query parameters
first_resultinteger · int32Optional

Offset from which the search must be performed

max_resultsinteger · int32Optional

Number of maximum items that shall be return by this search

Responses
200

Success !

application/json
max_resultsintegerRequired
first_resultintegerRequired
countintegerRequired
statusstring · enumRequiredPossible values:
totalintegerRequired
get/datamarts/{datamart_id}/user_data_stream_subscriptions
GET /v1/datamarts/{datamart_id}/user_data_stream_subscriptions HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "max_results": 1,
  "first_result": 1,
  "count": 1,
  "status": "ok",
  "total": 1,
  "data": [
    {
      "id": "text",
      "service_agreement_id": "text"
    }
  ]
}

create a user datastream subscription

post
/datamarts/{datamart_id}/user_data_stream_subscriptions
Path parameters
datamart_idinteger · int64Required
Body
idstringRead-onlyRequired
service_agreement_idstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/datamarts/{datamart_id}/user_data_stream_subscriptions
POST /v1/datamarts/{datamart_id}/user_data_stream_subscriptions HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "service_agreement_id": "text"
}
{
  "status": "ok",
  "data": {
    "id": "text",
    "service_agreement_id": "text"
  }
}

Delete user datastream subscription

delete
/datamarts/{datamart_id}/user_data_stream_subscriptions/{subscription_id}
Path parameters
datamart_idinteger · int64Required
subscription_idinteger · int64Required
Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/datamarts/{datamart_id}/user_data_stream_subscriptions/{subscription_id}
DELETE /v1/datamarts/{datamart_id}/user_data_stream_subscriptions/{subscription_id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

Last updated

Was this helpful?