Using the Audience API

This chapter describes how to place API calls to get the information you need. There are two ways to do this:

• Use the Audience API via the Mapp Server

• Use the Audience API with your own tracking domain

Audience API via the Mapp Server

Execute API calls to get all the segments a specified user belongs to. There are 2 versions of the API available. They only differ in the output of possible error messages: Version 2 supports additional information (see Error codes). Thus, it helps to better understand the type of error.

URI Syntax – Version 2 (recommended)

Using the Ever-ID

https://r.mateti.net/segments/v2/{trackId}/{placementId}?everId={everId}

Using the Customer-ID

https://r.mateti.net/segments/v2/{trackId}/{placementId}?customerId={customerId}

URI Syntax – Version 1

Using the Ever-ID

https://r.mateti.net/segments/v1/{trackId}/{placementId}?everId={everId}

Using the Customer-ID

https://r.mateti.net/segments/v1/{trackId}/{placementId}?customerId={customerId}

Query Parameters

Audience API with your own Tracking Domain

You can also use your own tracking domain or third-party cookies (due to ITP 2.x).

In this case a separate activation is required. Please contact your Mapp Intelligence consultant.

There are 2 versions of the API available. They only differ in the output of possible error messages: Version 2 supports additional information (see Error codes). Thus, it helps to better understand the type of error.

URI Syntax

{server}/segments/v1/{accountId}/{placementId}?customerId={customerId}

URI Syntax – Version 2 (recommended)

Using the Ever-ID

{server}/segments/v2/{trackId}/{placementId}?everId={everId}

Using the Customer-ID

{server}/segments/v2/{trackId}/{placementId}?customerId={customerId}

URI Syntax – Version 1

Using the Ever-ID

{server}/segments/v1/{trackId}/{placementId}?everId={everId}

Using the Customer-ID

{server}/segments/v1/{trackId}/{placementId}?customerId={customerId}

Query Parameters

GET Segment Information

Using the API via the Mapp server

GET https://r.mateti.net/segments/v2/1234567891234/23232323?customerId=04ee2ab263eeb5f0ca1139d7110f

Using the API with your own tracking domain

GET https:// {{OWN_TRACKING_DOMAIN}} /segments/v2/1234567891234/23232323?customerId=04ee2ab263eeb5f0ca1139d7110f

Headers

content-type: application/json

Response Syntax

{ 
    "user": <everID>, 
    "segments": {  
       "<segment name>" : <true|false>  
       "<segment name>" : <true|false> 
    },  
    "categories": [ 
       { 
         "id": <urm category id> 
         "title": "<urm category title>" 
         "value": "<urm category value>" 
       }, 
       {  
        "id": <urm category id> 
        "title": "<urm category title>" 
        "value": "<urm category value>" 
       } 
   ] 
} 

{     
    "everId": "87235498273549765",     
    "segments": { 
        "men" : true,  
        "high frequency buyer" : false 
    },  
    "categories": [ 
     {  
        "id": 1 
        "title": "URM Custom Profile Macro Status" 
        "value": "6" 
     }, 
     {  
        "id": 2 
        "title": "URM RFM Status" 
        "value": "322" 
     }, 
     {  
        "id": 3 
        "title": "URM Predicted conversion probability %" 
        "value": "" 
     } 
            
   ] 
} 

Possible Error Codes

Mapping Table for URM Status

There are four mapping tables available for the URM status.