Partner Match API

DataX’s Partner Match API audiences are keyed to an external Partner ID in a secured Verizon Media database that will process and store all successful mappings.

Note

Unmatched links will be removed from the system.

Updates

The Partner Match API is now available to upload #email and external Partner ID mapping data to Verizon Media.

The header and parameters are shown in the following table:

Parameter Name

Type

Sample Value

Optional

X-DATAX-URNTYPE

String

PXID

No

data

application/octet-stream

File_name of the file which is compressed in bz2 format

No

panel

String

IRI

Yes

schema

String

PXID,SHA256EMAIL

Yes

Endpoint

https://datax.yahooapis.com/v1/usermatch

POST /v1/usermatch

Sample Request

curl -X POST "http://datax.yahooapis.com/v1/usermatch"
-H "accept: application/json"
-H "X-DATAX-URNTYPE: pxid"
-H "X-DATAX-APP-ID: YAHOO"
-H "Content-Type: multipart/form-data"
-F "data=@hashedemail.csv.bz2;type=application/x-bzip2"

Sample Response

{
  "resourceType": "datax-usermatch",
  "resourceId": "YAHOO.usermatch.20200828T152057Z719526632",
  "createTime": "2020-08-28T07:20:57Z",
  "bytes": 93,
  "links": [
    {
      "rel": "self",
      "title": "A link to this meta data itself",
      "href": "http://datax.yahooapis.com/link/self/YAHOO.usermatch.20200828T152057Z719526632"
    },
    {
      "rel": "describes",
      "title": "A link to the data this metadata describes",
      "href": "http://datax.yahooapis.com/link/describes/YAHOO.usermatch.20200828T152057Z719526632"
    },
  {
      "rel": "matched metric",
      "title": "A link to get the matched metric for specific upload and it is ready 1+ day after uploading ",
      "href": "http://datax.yahooapis.com/link/stats/YAHOO.usermatch.20200828T152057Z719526632?type=UserMatch"
    },
 {
      "rel": "download matched record",
      "title": "A link to download the detail matched record for specific upload and it is ready 1+ day after uploading",
      "href": "http://datax.yahooapis.com/link/downloadmatch/YAHOO.usermatch.20200828T152057Z719526632"
    }  ],
  "status": {
    "state": "UPLOADING",
    "lastUpdateTime": "2020-08-28T15:20:57Z"
  },
  "extensions": {
    "urnType": "PXID",
    "view": "INCREMENTAL"
  }
}

Note

User partner matched IDs are available to download for 14 days from the time of ingestion. After 14 days, the downloadable link will expire.

Important

DataX has an upload size limitation of 5GB per file in a .bz2 compressed format. Alhough the limit on payload size of uploads is reasonably high, it is strongly recommended that data be uploaded in frequent mini-batches of incremental updates to optimize reach.