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

Segment Exports

Operations related to Segment Exports for exporting all user identifiers belonging to a specific segment. Enables bulk extraction of segment user data to files for external processing (like partner integrations, or data sharing scenarios without using mediarithmics platform capabilities). Exports can include various identifier types (emails, cookies, user accounts, device IDs) based on configuration requirements.

Perform action on JobExecution

post
/audience_segments/{segment_id}/exports/{export_id}/action
Path parameters
segment_idinteger · int64Required
export_idinteger · int64Required
Body
actionstring · enumRequiredPossible values:
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/audience_segments/{segment_id}/exports/{export_id}/action
POST /v1/audience_segments/{segment_id}/exports/{export_id}/action HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "action": "CANCEL"
}
{
  "status": "ok",
  "data": {
    "organisation_id": "text",
    "start_date": 0,
    "job_type": "text",
    "num_tasks": 0,
    "community_id": "text",
    "completed_tasks": 0,
    "max_retry_count": 0,
    "parameters": "text",
    "result": "text",
    "duration": 1,
    "cancel_status": "REQUESTED",
    "is_retryable": false,
    "status": "PENDING",
    "creation_date": 0,
    "user_id": "text",
    "id": "text",
    "erroneous_tasks": 0,
    "retry_count": 0,
    "permalink_uri": "text",
    "debug": "text",
    "external_name": "text"
  }
}

Get an audience segment export by id

get
/audience_segments/{segment_id}/exports/{export_id}
Path parameters
segment_idinteger · int64Required
export_idinteger · int64Required
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/audience_segments/{segment_id}/exports/{export_id}
GET /v1/audience_segments/{segment_id}/exports/{export_id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "organisation_id": "text",
    "start_date": 0,
    "job_type": "text",
    "num_tasks": 0,
    "community_id": "text",
    "completed_tasks": 0,
    "max_retry_count": 0,
    "parameters": "text",
    "result": "text",
    "duration": 1,
    "cancel_status": "REQUESTED",
    "is_retryable": false,
    "status": "PENDING",
    "creation_date": 0,
    "user_id": "text",
    "id": "text",
    "erroneous_tasks": 0,
    "retry_count": 0,
    "permalink_uri": "text",
    "debug": "text",
    "external_name": "text"
  }
}

Search the audience segment exports associated with a given audience segment id

get
/audience_segments/{segment_id}/exports
Path parameters
segment_idinteger · int64Required
Query parameters
statusstring · enumOptional

Status of the export

Possible values:
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
countintegerRequired
first_resultintegerRequired
statusstring · enumRequiredPossible values:
totalintegerRequired
get/audience_segments/{segment_id}/exports
GET /v1/audience_segments/{segment_id}/exports HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "max_results": 1,
  "count": 1,
  "data": [
    {
      "organisation_id": "text",
      "start_date": 0,
      "job_type": "text",
      "num_tasks": 0,
      "community_id": "text",
      "completed_tasks": 0,
      "max_retry_count": 0,
      "parameters": "text",
      "result": "text",
      "duration": 1,
      "cancel_status": "REQUESTED",
      "is_retryable": false,
      "status": "PENDING",
      "creation_date": 0,
      "user_id": "text",
      "id": "text",
      "erroneous_tasks": 0,
      "retry_count": 0,
      "permalink_uri": "text",
      "debug": "text",
      "external_name": "text"
    }
  ],
  "first_result": 1,
  "status": "ok",
  "total": 1
}

Create an audience segment export

post
/audience_segments/{segment_id}/exports
Path parameters
segment_idinteger · int64Required
Body
mime_typestring · enumRequiredPossible values:
include_prefixbooleanOptionalDefault: false
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/audience_segments/{segment_id}/exports
POST /v1/audience_segments/{segment_id}/exports HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "export_user_identifier": {
    "type": "USER_DEVICE_POINT"
  },
  "mime_type": "TEXT_CSV",
  "include_prefix": false
}
{
  "status": "ok",
  "data": {
    "organisation_id": "text",
    "start_date": 0,
    "job_type": "text",
    "num_tasks": 0,
    "community_id": "text",
    "completed_tasks": 0,
    "max_retry_count": 0,
    "parameters": "text",
    "result": "text",
    "duration": 1,
    "cancel_status": "REQUESTED",
    "is_retryable": false,
    "status": "PENDING",
    "creation_date": 0,
    "user_id": "text",
    "id": "text",
    "erroneous_tasks": 0,
    "retry_count": 0,
    "permalink_uri": "text",
    "debug": "text",
    "external_name": "text"
  }
}

Last updated

Was this helpful?