User points deletion

This document import allows you to mark user points for deletion.

Each line in the document is a user identifier that is linked to a user point (or is a user point id directly). For each of those identifiers, the job will find its associated user point and delete it, along with all of its identifiers, segments, scenario and its profile .

This is only supported for datamarts using a user point system version of v202205 or later.

How-to

  1. Use the bulk import endpoints to create a document import with the USER_POINTS_DELETION document type and APPLICATION_X_NDJSON mime type. Only ndjson data is supported.

  2. Create an execution with your commands formatted in ndjson. Each line can represent either a user agent, a user email, a user account or a user point id. Their respective syntax is detailed in User identifiers deletion.

Example

# Create the document import
curl -X POST \
  https://api.mediarithmics.com/v1/datamarts/<DATAMART_ID>/document_imports \
  -H 'Authorization: <YOUR_API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
	"document_type": "USER_DEVICE_POINT_DELETION",
	"mime_type": "APPLICATION_X_NDJSON",
	"encoding": "utf-8",
	"name": "<YOUR_DOCUMENT_IMPORT_NAME>"
}'
# Create the execution
curl -X POST \
  https://api.mediarithmics.com/v1/datamarts/<DATAMART_ID>/document_imports/<DOCUMENT_IMPORT_ID>/executions \
  -H 'Authorization: <API_TOKEN>' \
  -H 'Content-Type: application/x-ndjson' \
  -d '
    {
      "type": "USER_ACCOUNT",
      "compartment_id": "1000",
      "user_account_id": "8541254132"
    }
    {
      "type": "USER_EMAIL",
      "hash": "982f50d88d437d13bdbd541edfv4fe5176cc8d862f8cbe7ca4f0dc8ea"
    }
    { "type": "USER_AGENT", "user_agent_id": "vec:89998434" }
    { "type": "USER_AGENT", "user_agent_id": "udp:987654" }
    { "type": "USER_POINT", "user_point_id": "95772db3-e762-45da-8cf1-4893debffae7" }
  '

Please note that the uploaded data is in ndjson and not json. That means the different deletions are not separated by commas, but by a line separator.

Last updated