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

Datamart Device Id Registry

Operations related to Datamart Device ID Registries that store device-based Network IDs (IDFA, AAID, Universal Web IDs) for cross-publisher addressability. Enable collection and management of mobile advertising identifiers and universal web identifiers to support audience activation across multiple publishers and platforms while respecting user privacy controls.

Get device id registry

get
/device_id_registries/{id}
Path parameters
idstringRequired

The device id registry id

Query parameters
organisation_idstringOptional

Organisation id of the device id registry

Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/device_id_registries/{id}
GET /v1/device_id_registries/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "created_by": "text",
    "default_expiration_duration": "text",
    "id": "text",
    "creation_ts": 0,
    "drop_before_reduction": false,
    "image_uri": "text",
    "type": "INSTALLATION_ID",
    "organisation_id": "text",
    "last_modified_by": "text",
    "description": "text",
    "ignored_in_identity_resolution": false,
    "last_modified_ts": 0,
    "name": "text",
    "token": "text"
  }
}

Update device id registry

put
/device_id_registries/{id}
Path parameters
idstringRequired

The device id registry id

Query parameters
organisation_idstringOptional

Organisation id of the device id registry

Body
created_bystringRead-onlyRequired
default_expiration_durationstringRequired

A valid ISO 8601 Period String

idstringRead-onlyRequired
creation_tsinteger · int64Read-onlyRequiredDefault: 0
drop_before_reductionbooleanRequiredDefault: false
image_uristringOptional
typestring · enumRequiredPossible values:
organisation_idstringRequired
last_modified_bystringRead-onlyOptional
descriptionstringRequired
ignored_in_identity_resolutionbooleanRequiredDefault: false
last_modified_tsinteger · int64Read-onlyOptionalDefault: 0
namestringRequired
tokenstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/device_id_registries/{id}
PUT /v1/device_id_registries/{id} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "default_expiration_duration": "text",
  "drop_before_reduction": false,
  "image_uri": "text",
  "type": "INSTALLATION_ID",
  "organisation_id": "text",
  "description": "text",
  "ignored_in_identity_resolution": false,
  "name": "text",
  "token": "text"
}
{
  "status": "ok",
  "data": {
    "created_by": "text",
    "default_expiration_duration": "text",
    "id": "text",
    "creation_ts": 0,
    "drop_before_reduction": false,
    "image_uri": "text",
    "type": "INSTALLATION_ID",
    "organisation_id": "text",
    "last_modified_by": "text",
    "description": "text",
    "ignored_in_identity_resolution": false,
    "last_modified_ts": 0,
    "name": "text",
    "token": "text"
  }
}

Delete device id registry

delete
/device_id_registries/{id}
Path parameters
idstringRequired

The device id registry id

Query parameters
organisation_idstringOptional

Organisation id of the device id registry

Responses
200

Success response

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

Search device id registries

get
/device_id_registries
Query parameters
idsstring[]Optional

Ids of device id registries to search

namestringOptional

Name of device id registry

typestring · enumOptional

Type of device id registry

Possible values:
organisation_idstringOptional

Organisation id of the device id registry

created_bystringOptional

User who created the device id registry

last_modified_bystringOptional

User who last modified the device id registry

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
first_resultintegerRequired
max_resultsintegerRequired
totalintegerRequired
countintegerRequired
statusstring · enumRequiredPossible values:
get/device_id_registries
GET /v1/device_id_registries HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "first_result": 1,
  "max_results": 1,
  "total": 1,
  "data": [
    {
      "created_by": "text",
      "default_expiration_duration": "text",
      "id": "text",
      "creation_ts": 0,
      "drop_before_reduction": false,
      "image_uri": "text",
      "type": "INSTALLATION_ID",
      "organisation_id": "text",
      "last_modified_by": "text",
      "description": "text",
      "ignored_in_identity_resolution": false,
      "last_modified_ts": 0,
      "name": "text",
      "token": "text"
    }
  ],
  "count": 1,
  "status": "ok"
}

Create a device id registry

post
/device_id_registries
Body
created_bystringRead-onlyRequired
default_expiration_durationstringRequired

A valid ISO 8601 Period String

idstringRead-onlyRequired
creation_tsinteger · int64Read-onlyRequiredDefault: 0
drop_before_reductionbooleanRequiredDefault: false
image_uristringOptional
typestring · enumRequiredPossible values:
organisation_idstringRequired
last_modified_bystringRead-onlyOptional
descriptionstringRequired
ignored_in_identity_resolutionbooleanRequiredDefault: false
last_modified_tsinteger · int64Read-onlyOptionalDefault: 0
namestringRequired
tokenstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/device_id_registries
POST /v1/device_id_registries HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "default_expiration_duration": "text",
  "drop_before_reduction": false,
  "image_uri": "text",
  "type": "INSTALLATION_ID",
  "organisation_id": "text",
  "description": "text",
  "ignored_in_identity_resolution": false,
  "name": "text",
  "token": "text"
}
{
  "status": "ok",
  "data": {
    "created_by": "text",
    "default_expiration_duration": "text",
    "id": "text",
    "creation_ts": 0,
    "drop_before_reduction": false,
    "image_uri": "text",
    "type": "INSTALLATION_ID",
    "organisation_id": "text",
    "last_modified_by": "text",
    "description": "text",
    "ignored_in_identity_resolution": false,
    "last_modified_ts": 0,
    "name": "text",
    "token": "text"
  }
}

Last updated

Was this helpful?