Mappings Service

Coming Soon! 

More mappings to be included in a future release.

The mappings service provides more information about your client audit logs. The logs that you retrieve include identifiers, but not the corresponding name mappings. You can use the API endpoints listed below to return the following name mappings:

Buyer Mapping

The buyer mapping returns the buyer name that corresponds to each DSP ID and Trading Desk ID. Your request must use the following format:

Request Parameter Value
Type GET
Resource /mappings/buyers
Header Authorization: Bearer <access_token>

In the header, <access_token> is the access token you received from the response during authentication.

The following is a sample call:


curl https://app.indexexchange.com/api/cal/v1/mappings/buyers -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJQTVhhU2F5TVhxeWhfQVFSX0RSdThfNEFodDcwVTVjNFBMa2J6VGhCa04wIn0.eyJqdGkiOiJlYzY3ZTY4OS0zNDMwLTQ3ZGEtOTlhMS02Y2ZjOTFlM2ZhNTYiLCJleHAiOjE1MzkxMTQ0MzAsIm5iZiI6MCwiaWF0IjoxNTM5MTEwODMwLCJpc3MiOiJodHRwczovL2lkZW50aXR5LXRlc3QuaW5kZXhleGNoYW5nZS5jb20vYXV0aC9yZWFsbXMvZXZlbnRsb2ciLCJhdWQiOiJ0ZXN0LW1lcmtsZS1jbGllbnQiLCJzdWIiOiIwODA2MWU4OS05ODE3LTQ5NDgtYThmMC03ZTgyODk1ZTdlNGQiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJ0ZXN0LW1lcmtsZS1jbGllbnQiLCJhdXRoX3RpbWUiOjAsInNlc3Npb25fc3RhdGUiOiI3ZjlkNWVmZC02OTkzLTQyMTgtOTZkNy1mZjUxZmEyMDE3YzMiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsidGVzdC1tZXJrbGUtY2xpZW50Ijp7InJvbGVzIjpbInVtYV9wcm90ZWN0aW9uIl19LCJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJldmVudExvZ0NsaWVudElkIjoiMTIiLCJjbGllbnRJZCI6InRlc3QtbWVya2xlLWNsaWVudCIsImNsaWVudEhvc3QiOiIxMC4yMzMuNzMuOTMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJzZXJ2aWNlLWFjY291bnQtdGVzdC1tZXJrbGUtY2xpZW50IiwiY2xpZW50QWRkcmVzcyI6IjEwLjIzMy43My45MyIsImVtYWlsIjoic2VydmljZS1hY2NvdW50LXRlc3QtbWVya2xlLWNsaWVudEBwbGFjZWhvbGRlci5vcmcifQ.J9AXq_S_oemRmiAXPvmKvH0OokeQ0Oi8HcX2H_wy7shl7JTpfTttl6NsR1MpcnKjDtJRW1d-IBmQdGrD2y58T74ZPnsPHFVuW_Euj2xJwZf0T5rI_N8K8cL9o6mZfHQc0dTFCMdxzZM0n0QU3pli6yB_I8Gt7GDGaIsgO6jjF8ovN-7WMGGu9WJ0q4d1gzdWkYa8gzE1EwEUWAsQokZZ20ZRoLGbwmyzQ5EeXaz0UJapACvY9qmjdDl0zldn5XxTkqzkWCdhw11J514Ju5IzkRH7pBc5ky5frhKP52dzRF9r9f0rTDJpYWWiAldX1ceJRbMULyfS9EUi9oE1mSWMoQ" 
200 OK
{
    "data": [
        {
            "dsp_id": 4,
            "trading_desk_id": 367,
            "buyer_name": "Best Buy"
        },
        {
            "dsp_id": 4,
            "trading_desk_id": 420,
            "buyer_name": "Nordstrom"
        }
    ]
}

See the JSON field definitions below for more details about the fields in the response:

Field Description
dsp_id This is the unique identifier for the DSP, which is returned when you retrieve client audit logs.
trading_desk_id This is the unique identifier for trading desk, which is returned when you retrieve client audit logs.
buyer_name This is the buyer name that corresponds to those identifiers.

Campaign Mapping

Note

This route only returns information about campaigns that have an associated brand. It's currently only available for buyers.

The campaign mapping returns information about the campaign, including the campaign ID, the campaign name, the brand ID and the brand name. The mapping also returns information about any creative associated with the campaign, including the creative ID, and the creative name. Your request must use the following format:

Request Parameter Value
Type GET
Resource /mappings/campaigns
Header Authorization: Bearer <access_token>

In the header, <access_token> is the access token you received from the response during authentication.

The following is a sample call:

curl https://app.indexexchange.com/api/cal/v1/mappings/campaigns -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJQTVhhU2F5TVhxeWhfQVFSX0RSdThfNEFodDcwVTVjNFBMa2J6VGhCa04wIn0.eyJqdGkiOiJlYzY3ZTY4OS0zNDMwLTQ3ZGEtOTlhMS02Y2ZjOTFlM2ZhNTYiLCJleHAiOjE1MzkxMTQ0MzAsIm5iZiI6MCwiaWF0IjoxNTM5MTEwODMwLCJpc3MiOiJodHRwczovL2lkZW50aXR5LXRlc3QuaW5kZXhleGNoYW5nZS5jb20vYXV0aC9yZWFsbXMvZXZlbnRsb2ciLCJhdWQiOiJ0ZXN0LW1lcmtsZS1jbGllbnQiLCJzdWIiOiIwODA2MWU4OS05ODE3LTQ5NDgtYThmMC03ZTgyODk1ZTdlNGQiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJ0ZXN0LW1lcmtsZS1jbGllbnQiLCJhdXRoX3RpbWUiOjAsInNlc3Npb25fc3RhdGUiOiI3ZjlkNWVmZC02OTkzLTQyMTgtOTZkNy1mZjUxZmEyMDE3YzMiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsidGVzdC1tZXJrbGUtY2xpZW50Ijp7InJvbGVzIjpbInVtYV9wcm90ZWN0aW9uIl19LCJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJldmVudExvZ0NsaWVudElkIjoiMTIiLCJjbGllbnRJZCI6InRlc3QtbWVya2xlLWNsaWVudCIsImNsaWVudEhvc3QiOiIxMC4yMzMuNzMuOTMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJzZXJ2aWNlLWFjY291bnQtdGVzdC1tZXJrbGUtY2xpZW50IiwiY2xpZW50QWRkcmVzcyI6IjEwLjIzMy43My45MyIsImVtYWlsIjoic2VydmljZS1hY2NvdW50LXRlc3QtbWVya2xlLWNsaWVudEBwbGFjZWhvbGRlci5vcmcifQ.J9AXq_S_oemRmiAXPvmKvH0OokeQ0Oi8HcX2H_wy7shl7JTpfTttl6NsR1MpcnKjDtJRW1d-IBmQdGrD2y58T74ZPnsPHFVuW_Euj2xJwZf0T5rI_N8K8cL9o6mZfHQc0dTFCMdxzZM0n0QU3pli6yB_I8Gt7GDGaIsgO6jjF8ovN-7WMGGu9WJ0q4d1gzdWkYa8gzE1EwEUWAsQokZZ20ZRoLGbwmyzQ5EeXaz0UJapACvY9qmjdDl0zldn5XxTkqzkWCdhw11J514Ju5IzkRH7pBc5ky5frhKP52dzRF9r9f0rTDJpYWWiAldX1ceJRbMULyfS9EUi9oE1mSWMoQ" 
200 OK
{
    "data": [
        {
            "brand_id": 99827,
            "brand_name": "P&G - Gillette",
            "campaign_id": 6,
            "campaign_name": "P&G - Gillette PVTX #IX526660642745354967",
            "creatives": [
                {
                    "creative_id": 6,
                    "creative_name": "ctat2s8"
                },
                {
                    "creative_id": 48,
                    "creative_name": "ctat2s9"
                }
            ]
        },
        {
            "brand_id": 99827,
            "brand_name": "P&G - Vicks",
            "campaign_id": 15,
            "campaign_name": "P&G - Vicks PVTX #IX526660642745354547",
            "creatives": [
                {
                    "creative_id": 15,
                    "creative_name": "ctat2s7"
                }
            ]
        },
        {
            "brand_id": 310629,
            "brand_name": "P&G - Crest",
            "campaign_id": 46,
            "campaign_name": "P&G - Crest PVTX #3311091705",
            "creatives": [...]
        }
    ]
}

 

See the JSON field definitions below for more details about the fields in the response:

Field Description
brand_id This is the unique identifier for the brand, which is returned when you retrieve client audit logs.
brand_name The name that corresponds to the brandID.
campaign_id The unique identifier for the campaign.
campaign_name The name that corresponds to the campaignID.
creatives An object which contains information about the creative.
creative_id This is the unique identifier for the creative.
creative_name The name that corresponds to the creativeID.

Deal Mapping

The deal mapping returns additional information about your deals, such as the deal name and effective dates for each deal ID. Your request must use the following format:

Request Parameter Value
Type GET
Resource /mappings/deals
Header Authorization: Bearer <access_token>

In the header, <access_token> is the access token you received from the response during authentication.

The following is a sample call:

curl https://app.indexexchange.com/api/cal/v1/mappings/deals -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJQTVhhU2F5TVhxeWhfQVFSX0RSdThfNEFodDcwVTVjNFBMa2J6VGhCa04wIn0.eyJqdGkiOiJlYzY3ZTY4OS0zNDMwLTQ3ZGEtOTlhMS02Y2ZjOTFlM2ZhNTYiLCJleHAiOjE1MzkxMTQ0MzAsIm5iZiI6MCwiaWF0IjoxNTM5MTEwODMwLCJpc3MiOiJodHRwczovL2lkZW50aXR5LXRlc3QuaW5kZXhleGNoYW5nZS5jb20vYXV0aC9yZWFsbXMvZXZlbnRsb2ciLCJhdWQiOiJ0ZXN0LW1lcmtsZS1jbGllbnQiLCJzdWIiOiIwODA2MWU4OS05ODE3LTQ5NDgtYThmMC03ZTgyODk1ZTdlNGQiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJ0ZXN0LW1lcmtsZS1jbGllbnQiLCJhdXRoX3RpbWUiOjAsInNlc3Npb25fc3RhdGUiOiI3ZjlkNWVmZC02OTkzLTQyMTgtOTZkNy1mZjUxZmEyMDE3YzMiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsidGVzdC1tZXJrbGUtY2xpZW50Ijp7InJvbGVzIjpbInVtYV9wcm90ZWN0aW9uIl19LCJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJldmVudExvZ0NsaWVudElkIjoiMTIiLCJjbGllbnRJZCI6InRlc3QtbWVya2xlLWNsaWVudCIsImNsaWVudEhvc3QiOiIxMC4yMzMuNzMuOTMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJzZXJ2aWNlLWFjY291bnQtdGVzdC1tZXJrbGUtY2xpZW50IiwiY2xpZW50QWRkcmVzcyI6IjEwLjIzMy43My45MyIsImVtYWlsIjoic2VydmljZS1hY2NvdW50LXRlc3QtbWVya2xlLWNsaWVudEBwbGFjZWhvbGRlci5vcmcifQ.J9AXq_S_oemRmiAXPvmKvH0OokeQ0Oi8HcX2H_wy7shl7JTpfTttl6NsR1MpcnKjDtJRW1d-IBmQdGrD2y58T74ZPnsPHFVuW_Euj2xJwZf0T5rI_N8K8cL9o6mZfHQc0dTFCMdxzZM0n0QU3pli6yB_I8Gt7GDGaIsgO6jjF8ovN-7WMGGu9WJ0q4d1gzdWkYa8gzE1EwEUWAsQokZZ20ZRoLGbwmyzQ5EeXaz0UJapACvY9qmjdDl0zldn5XxTkqzkWCdhw11J514Ju5IzkRH7pBc5ky5frhKP52dzRF9r9f0rTDJpYWWiAldX1ceJRbMULyfS9EUi9oE1mSWMoQ" 
200 OK
{
    "data": [
        {
            "deal_id": "IX513654793266898038",
            "deal_name": "Comscore Top 10 - Mobile - 300x250",
            "dsp_id": 85,
            "deal_type": 0,
            "auction_type": "first",
            "rate": 1.99,
	        "section_id": [1,4,7],	
            "status": "A",
            "start_date": "2017-12-18",
            "end_date": "2027-12-31",
            "priority": 5
        },
        {
            "deal_id": "IX513654786679159111",
            "deal_name": "Football Enthusiasts - Desktop - 300x600",
            "dsp_id": 85,
            "deal_type": 0,
            "auction_type": "first",
            "rate": 1.99, 
	        "section_id": [1,4,7],
            "status": "A",
            "start_date": "2017-12-18",
            "end_date": "2027-12-31",
            "priority": 5
        }
    ]
}

See the JSON field definitions below for more details about the fields in the response:

Field Description
deal_id This is the unique identifier for the deal, which is returned when you retrieve client audit logs.
deal_name The name that corresponds to the dealID.
dsp_id The unique identifier for the DSP.
deal_type The ID for the deal type. Possible values are 1 (for one-to-many deals) and 0 (for one-to-one deals).
auction_type The auction type for the deal. Possible values are first, second, and fixed.
rate The floor rate for the deal, formatted two decimal places (e.g. 1.99).
section_id The IDs of the deal sections associated with the deal.
status The status of the deal. Possible values are A (active), D (deactivated or deleted), and N (new).
start_date The date the deal starts, formatted as YYYY-MM-DD.
end_date The date the deal ends, formatted as YYYY-MM-DD.
priority The priority of the deal, formatted as a value between 1 (lowest priority) and 10 (highest priority).

DSP Mapping

The DSP mapping call returns the DSP name that maps to each DSP ID. Your request must use the following format:

Request Parameter Value
Type GET
Resource /mappings/dsps
Header Authorization: Bearer <access_token>

In the header, <access_token> is the access token you received from the response during authentication.

The following is a sample call:


curl  https://app.indexexchange.com/api/cal/v1/mappings/dsps -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJQTVhhU2F5TVhxeWhfQVFSX0RSdThfNEFodDcwVTVjNFBMa2J6VGhCa04wIn0.eyJqdGkiOiJlYzY3ZTY4OS0zNDMwLTQ3ZGEtOTlhMS02Y2ZjOTFlM2ZhNTYiLCJleHAiOjE1MzkxMTQ0MzAsIm5iZiI6MCwiaWF0IjoxNTM5MTEwODMwLCJpc3MiOiJodHRwczovL2lkZW50aXR5LXRlc3QuaW5kZXhleGNoYW5nZS5jb20vYXV0aC9yZWFsbXMvZXZlbnRsb2ciLCJhdWQiOiJ0ZXN0LW1lcmtsZS1jbGllbnQiLCJzdWIiOiIwODA2MWU4OS05ODE3LTQ5NDgtYThmMC03ZTgyODk1ZTdlNGQiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJ0ZXN0LW1lcmtsZS1jbGllbnQiLCJhdXRoX3RpbWUiOjAsInNlc3Npb25fc3RhdGUiOiI3ZjlkNWVmZC02OTkzLTQyMTgtOTZkNy1mZjUxZmEyMDE3YzMiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsidGVzdC1tZXJrbGUtY2xpZW50Ijp7InJvbGVzIjpbInVtYV9wcm90ZWN0aW9uIl19LCJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJldmVudExvZ0NsaWVudElkIjoiMTIiLCJjbGllbnRJZCI6InRlc3QtbWVya2xlLWNsaWVudCIsImNsaWVudEhvc3QiOiIxMC4yMzMuNzMuOTMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJzZXJ2aWNlLWFjY291bnQtdGVzdC1tZXJrbGUtY2xpZW50IiwiY2xpZW50QWRkcmVzcyI6IjEwLjIzMy43My45MyIsImVtYWlsIjoic2VydmljZS1hY2NvdW50LXRlc3QtbWVya2xlLWNsaWVudEBwbGFjZWhvbGRlci5vcmcifQ.J9AXq_S_oemRmiAXPvmKvH0OokeQ0Oi8HcX2H_wy7shl7JTpfTttl6NsR1MpcnKjDtJRW1d-IBmQdGrD2y58T74ZPnsPHFVuW_Euj2xJwZf0T5rI_N8K8cL9o6mZfHQc0dTFCMdxzZM0n0QU3pli6yB_I8Gt7GDGaIsgO6jjF8ovN-7WMGGu9WJ0q4d1gzdWkYa8gzE1EwEUWAsQokZZ20ZRoLGbwmyzQ5EeXaz0UJapACvY9qmjdDl0zldn5XxTkqzkWCdhw11J514Ju5IzkRH7pBc5ky5frhKP52dzRF9r9f0rTDJpYWWiAldX1ceJRbMULyfS9EUi9oE1mSWMoQ'"
200 OK
{
    "data": [
        {
            "dsp_id": 47,
            "dsp_name": "DataXu"
        },
        {
            "dsp_id": 94,
            "dsp_name": "MediaMath"
        }
    ]
}

See the JSON field definitions below for more details about the fields in the response:

Field Description
dsp_id This is the unique identifier for the DSP, which is returned when you retrieve client audit logs.
dsp_name This is the DSP name that corresponds to the identifier.

Site Mapping

Note

Site mapping is currently only available for publishers.

The site mapping returns the site name that corresponds to each site ID. Your request must use the following format:

Request Parameter Value
Type GET
Resource /mappings/sites
Header Authorization: Bearer <access_token>

In the header, <access_token> is the access token you received from the response during authentication.

The following is a sample call:

curl https://app.indexexchange.com/api/cal/v1/mappings/sites -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJQTVhhU2F5TVhxeWhfQVFSX0RSdThfNEFodDcwVTVjNFBMa2J6VGhCa04wIn0.eyJqdGkiOiJlYzY3ZTY4OS0zNDMwLTQ3ZGEtOTlhMS02Y2ZjOTFlM2ZhNTYiLCJleHAiOjE1MzkxMTQ0MzAsIm5iZiI6MCwiaWF0IjoxNTM5MTEwODMwLCJpc3MiOiJodHRwczovL2lkZW50aXR5LXRlc3QuaW5kZXhleGNoYW5nZS5jb20vYXV0aC9yZWFsbXMvZXZlbnRsb2ciLCJhdWQiOiJ0ZXN0LW1lcmtsZS1jbGllbnQiLCJzdWIiOiIwODA2MWU4OS05ODE3LTQ5NDgtYThmMC03ZTgyODk1ZTdlNGQiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJ0ZXN0LW1lcmtsZS1jbGllbnQiLCJhdXRoX3RpbWUiOjAsInNlc3Npb25fc3RhdGUiOiI3ZjlkNWVmZC02OTkzLTQyMTgtOTZkNy1mZjUxZmEyMDE3YzMiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsidGVzdC1tZXJrbGUtY2xpZW50Ijp7InJvbGVzIjpbInVtYV9wcm90ZWN0aW9uIl19LCJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJldmVudExvZ0NsaWVudElkIjoiMTIiLCJjbGllbnRJZCI6InRlc3QtbWVya2xlLWNsaWVudCIsImNsaWVudEhvc3QiOiIxMC4yMzMuNzMuOTMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJzZXJ2aWNlLWFjY291bnQtdGVzdC1tZXJrbGUtY2xpZW50IiwiY2xpZW50QWRkcmVzcyI6IjEwLjIzMy43My45MyIsImVtYWlsIjoic2VydmljZS1hY2NvdW50LXRlc3QtbWVya2xlLWNsaWVudEBwbGFjZWhvbGRlci5vcmcifQ.J9AXq_S_oemRmiAXPvmKvH0OokeQ0Oi8HcX2H_wy7shl7JTpfTttl6NsR1MpcnKjDtJRW1d-IBmQdGrD2y58T74ZPnsPHFVuW_Euj2xJwZf0T5rI_N8K8cL9o6mZfHQc0dTFCMdxzZM0n0QU3pli6yB_I8Gt7GDGaIsgO6jjF8ovN-7WMGGu9WJ0q4d1gzdWkYa8gzE1EwEUWAsQokZZ20ZRoLGbwmyzQ5EeXaz0UJapACvY9qmjdDl0zldn5XxTkqzkWCdhw11J514Ju5IzkRH7pBc5ky5frhKP52dzRF9r9f0rTDJpYWWiAldX1ceJRbMULyfS9EUi9oE1mSWMoQ" 
200 OK
{
  "data": [
    {
      "site_id": 1,
      "site_name": "Recipe.com"
    },
    {
      "site_id": 2,
      "site_name": "Fitness.com"
    },
    {
      "site_id": 3,
      "site_name": "bhg.com"
    },
    {
      "site_id": 100,
      "site_name": "DivineCaroline.com"
    }
  ]
}

See the JSON field definitions below for more details about the fields in the response:

Field Description
site_id This is the unique identifier for the site, which is returned when you retrieve client audit logs.
site_name This is the site name that corresponds to the identifier.