`user_segment_breakdown` dimension

The user_segment_breakdown dimension (of the Campaign Summary Report) now includes an id column.

The id column displays Taboola's internal Audience ID - and can be used to retarget an audience in another campaign.

This cuts out the extra step of 'looking up' the internal Audience ID via the Dictionary endpoint (dictionary/audience_segments).

Example

Run the Campaign Summary Report with the user_segment_breakdown dimension:

GET <<server_url>>/backstage/api/1.0/demo-account/reports/campaign-summary/dimensions/user_segment_breakdown?start_date=2021-05-21&end_date=2021-05-27

{
    ...
    "results": [
        {
            "id": 49190,
            "data_partner_audience_id": "63235",
            "partner_name": "Lotame",
            "audience_name": "Entertainment",
            "audience_description": "Those who have declared an interest in Entertainment or navigated to pages, read articles, uploaded photos, etc. about movies, music, television, video games, online games, celebrities and pop culture.",
            "clicks": 189,
            "impressions": 497022,
            "visible_impressions": 86900,
            "impressions_pct": 85.02,
            "spent": 45.15,
            "cpa_actions_num": 36,
            "ctr": 0.038026485749121800,
            "vctr": 0.217491369390103600,
            "cpm": 0.09,
            "vcpm": 0.52,
            "cpc": 0.24,
            "cpa": 1.25,
            "cpa_conversion_rate": 19.047619047619047600,
            "currency": "USD",
            "cvr_uplift": null,
            "cvr_uplift_confidence": null,
            "cvr_uplift_weighted": null
        },
        {
            "id": 48869,
            "data_partner_audience_id": "2722",
            "partner_name": "Lotame",
            "audience_name": "Automobiles",
            "audience_description": "Those who have declared an interest in Automobiles or navigated to pages, read articles, uploaded photos, etc. about Automobiles",
            "clicks": 189,
            "impressions": 490507,
            "visible_impressions": 85571,
            "impressions_pct": 83.91,
            "spent": 45.15,
            "cpa_actions_num": 36,
            "ctr": 0.038531560201995100,
            "vctr": 0.220869219712285700,
            "cpm": 0.09,
            "vcpm": 0.53,
            "cpc": 0.24,
            "cpa": 1.25,
            "cpa_conversion_rate": 19.047619047619047600,
            "currency": "USD",
            "cvr_uplift": null,
            "cvr_uplift_confidence": null,
            "cvr_uplift_weighted": null
        }
    ]
    ...
}

Using the id values returned above, apply Marketplace Audience Targeting to campaign 1234:

POST <<server_url>>/backstage/api/1.0/demo-account/campaigns/1234/targeting/audience_segments

{
    "collection": [
        {
            "collection": [
                49190,
                48869
            ],
            "type": "INCLUDE"
        }
    ]
}