Developer
User guidesDeveloper websiteHelp centerLog in
  • Welcome!
  • Organisations structure
    • Datamart
    • Users and roles
  • User points
    • User identifiers
      • Networks IDs
        • Device-based Network IDs
          • Custom Device ID integration
          • ID5
          • First ID
        • User-based Network IDs
          • Custom User ID integration
          • UTIQ martechpass
      • Accounts
      • Emails
      • Device identifiers
    • User activities and events
    • Compartments
    • User profiles
    • User segments
    • Hyper point & Quarantine
  • Data model
    • Defining your schema
    • Computed fields
      • Concepts
      • Setup
      • Development
      • Examples
  • Data ingestion
    • Real time user tracking
      • Website tracking
      • Mobile apps tracking
      • Ads exposure tracking
      • AMP tracking
      • Conversions tracking
      • Email views and clicks
      • Tracking API
      • Event rules
      • Activity analyzers
    • Bulk processing
      • Imports
        • User activities import
        • User profiles import
        • User choices import
        • Segments import
      • Deletions
        • User identifiers deletion
        • Device points deletion
        • User points deletion
      • User identifiers association
      • Integration batch
    • Activities analytics
    • Data warehouse
      • Preliminary setup
        • BigQuery
      • Create data warehouse
  • Querying your data
    • OTQL queries
    • OTQL examples
    • GraphQL queries
    • UserPoint API
    • User activities
    • Activities analytics queries
      • API Quickstart
      • Dimensions and metrics
      • Use cases
    • Funnel API
  • Alerting
    • Alert configurations
  • Data visualisation
    • Quickstart
    • Dashboards
    • Sections and cards
    • Charts
    • Datasets and data sources
      • Using a data file data source
    • Transformations
    • Filters
    • Cookbook
    • Reference
  • Advanced usages
    • Audience segmentation
      • Audience features
      • Segment builders
      • Audience segment metrics
      • Audience segment feed
        • Building new feeds
        • Monitoring a feed
        • Curated Audiences (SDA)
      • Edge segments
      • Cohort-based Lookalike
    • Contextual targeting
      • Setup
      • Activation
        • Google Ad Manager
        • Xandr (through prebid.js)
      • API documentation
    • Exporting your data
      • Query Exports
      • Datamart replication
    • Data privacy compliance
      • User choices
      • Cleaning rules
      • Exercise of user rights
      • Cookies
    • Campaigns
    • Automations
      • Email routers
      • Email renderers
      • Opt-in provider
      • Custom action plugins
      • Usage limits for automations
    • Plugins
      • Concepts
      • Creation & Deployment
      • Coding your plugin
      • Manage existing plugins
      • Layouts
      • Presets
      • Monitoring
      • Throttling
      • Batching (for external feeds)
    • Platform monitoring
      • Resources usage
        • Dimensions and metrics
      • Collection volumes
        • Dimensions and metrics
      • Events ingestion monitoring
        • Dimensions and metrics
    • Data Clean Room
      • Bunker
      • Clean room
  • Resources
    • Tutorial: Data Ingestion
      • Your first events
        • Add the mediarithmics tag
          • Getting the tag
          • Adding the tag
        • Send events using the tag
          • Adding event properties
          • Finding the UserEvent type in your schema
          • Matching your schema
          • Standard events
      • Your first bulk imports
        • API basics
          • Authentication
          • Your first API call
        • Send documents using the API
          • Requirements
          • Sending documents
    • Using our API
      • Authentication
    • Tools & libraries
      • mics CLI
      • JS Tag
      • Plugin SDK
    • Data cubes
      • Creating a report
      • Reference
Powered by GitBook
On this page
  • Retrieve all targeting lists
  • Retrieve targeting list basic information
  • Retrieve semantic targeting list query
  • Retrieve IAB category information
  • Retrieve entity information
  • Retrieve overal metrics for a particular query
  • Retrieve panel based contextual targeting settings
  • Publish a contextual targeting (LIVE)
  • Archive a contextual targeting
  • Retrieve all targeting lists
  • Retrieve targeting list basic information
  • Retrieve semantic targeting list query
  • Retrieve IAB category information
  • Retrieve entity information
  • Retrieve overal metrics for a particular query
  • Retrieve panel based contextual targeting settings
  • Publish a contextual targeting (LIVE)
  • Archive a contextual targeting
  • Retrieve all targeting lists
  • Retrieve targeting list basic information
  • Retrieve semantic targeting list query
  • Retrieve IAB category information
  • Retrieve entity information
  • Retrieve overal metrics for a particular query
  • Retrieve panel based contextual targeting settings
  • Publish a contextual targeting (LIVE)
  • Archive a contextual targeting

Was this helpful?

Export as PDF
  1. Advanced usages
  2. Contextual targeting

API documentation

Retrieve all targeting lists

GET https://api.mediarithmics.com/v1/organisations/:organisationId/contextual/targeting_lists

Path Parameters

Name
Type
Description

organisationId*

integer

The ID of the organisation for which you want to retrieve the targeting lists

{
    "status": "ok",
    "data": [
        {
            "type": "SEMANTIC",
            "id": "1",
            "organisation_id": "1",
            "status": "INIT",
            "live_activation_ts": null,
            "name": "Targeting_List_Name",
            "short_description": "",
            "token": "cardinal-ack",
            "url_count": 21860,
            "last_30_days_page_views": 8066996,
            "created_ts": 1692607279222,
            "created_by": "1",
            "last_modified_ts": null,
            "last_modified_by": null,
            "archived": false,
            "query_id": "1"
        }
    ],
    "count": 1,
    "total": 1,
    "first_result": 0,
    "max_results": 10
}

Retrieve targeting list basic information

GET https://api.mediarithmics.com/v1/organisations/:organisationId/contextual/targeting_lists/:targetingListId

Path Parameters

Name
Type
Description

organisationId*

integer

The ID of the organisation

targetingListId*

Integer

The ID of the targeting list to retrieve

{
    "status": "ok",
    "data": {
        "type": "SEMANTIC",    // SEMANTIC, PANEL_BASED
        "id": "1",
        "organisation_id": "1",
        "segment_id": "7105867",    // Only for PANEL_BASED type
        "volume_ratio": 0.8313403,    // Only for PANEL_BASED type
        "status": "INIT",
        "live_activation_ts": null,
        "last_lift_computation_ts": 1700100423716,    // Only for PANEL_BASED type
        "name": "Targeting_List_Name",
        "short_description": "",
        "token": "cardinal-ack",
        "url_count": 21860,
        "last_30_days_page_views": 8066996,
        "created_ts": 1692607279222,
        "created_by": "1",
        "last_modified_ts": null,
        "last_modified_by": null,
        "archived": false,
        "query_id": "1"    // Only for SEMANTIC type
    }
}

Retrieve semantic targeting list query

GET https://api.mediarithmics.com/v1/organisations/:organisationId/contextual/queries/:queryId

Path Parameters

Name
Type
Description

organisationId*

integer

The ID of the organisation

queryId*

Integer

The ID of the query retrieved in a seamntic targeting list

{
    "status": "ok",
    "data": {
        "id": "1",
        "organisation_id": "1",
        "query_data": {
            "language_name": "JSON_SEMANTIC",
            "language_version": "1",
            "query": {
                "include": {
                    "entity_ids": [
                        "1",
                        "2"
                    ],
                    "iab_category_ids": [
                        "1"
                    ]
                },
                "exclude": {
                    "entity_ids": [],
                    "channel_ids": [
                        "1",
                        "2",
                        "3",
                        "4",
                        "5"
                    ],
                    "iab_category_ids": []
                }
            }
        },
        "created_by": "1",
        "created_ts": 1692607279084,
        "last_modified_by": null,
        "last_modified_ts": null
    }
}

Retrieve IAB category information

GET https://api.mediarithmics.com/v1/communities/:communityId/contextual/categories/:categoryId

Path Parameters

Name
Type
Description

communityId*

integer

The ID of the community

categoryId*

Integer

The ID of the category to be retrieved

{
    "status": "ok",
    "data": {
        "id": "25",
        "name": "News and Politics>Politics>War and Conflicts",
        "url_count": 13549,
        "last_30_days_page_views": 4914430
    }
}

Retrieve entity information

GET https://api.mediarithmics.com/v1/communities/:communityId/contextual/entities/:entityId

Path Parameters

Name
Type
Description

organisationId*

integer

The ID of the organisation

entityId*

Integer

The ID of the entity to be retrieved

{
    "status": "ok",
    "data": {
        "id": "287",
        "name": "Paris Saint-Germain Football Club",
        "type": "SoccerClub",
        "wikidata_id": "Q483020",
        "url_count": 4601,
        "last_30_days_page_views": 2095819
    }
}

Retrieve overal metrics for a particular query

POST https://api.mediarithmics.com/v1/communities/:communityId/contextual/analytics/overall_metrics

Path Parameters

Name
Type
Description

organisationId*

integer

The ID of the organisation

{
    "status":"ok",
    "data":
    {
        "url_count":13549,
        "last_30_days_page_views":4914430
    }
}

Retrieve panel based contextual targeting settings

GET https://api.mediarithmics.com/v1/audience_segments/:segmentId/contextual_targetings

Path Parameters

Name
Type
Description

segmentId*

integer

The ID of the audience segment on which

{
    "status": "ok",
    "data": [
        {
            "type": "PANEL_BASED",
            "id": "1",
            "organisation_id": "1",
            "segment_id": "1",
            "volume_ratio": 0.8313403,
            "status": "LIVE",
            "live_activation_ts": 1678193619193,
            "last_lift_computation_ts": 1700100423716,
            "name": "Targeting_List_Name",
            "short_description": null,
            "token": "double-beer-maryland",
            "url_count": 3746,
            "last_30_days_page_views": 63824027,
            "created_ts": 1678193048401,
            "created_by": "1",
            "last_modified_ts": 1700055578893,
            "last_modified_by": "1",
            "archived": false
        }
    ],
    "count": 1,
    "total": 1,
    "first_result": 0,
    "max_results": 2147483647
}

Publish a contextual targeting (LIVE)

POST https://api.mediarithmics.com/v1/audience_segments/:segmentId/contextual_targetings/:contextualTargetingId/actions

Path Parameters

Name
Type
Description

segmentId*

integer

The ID of the audience segment on which

contextualTargetingId*

Integer

The ID of the contextual targeting retrieved in creation response

Request Body

Name
Type
Description

type*

string

"PUBLISH"

volume_ratio*

float

% of audience segment reach (30-day page views) that will be used to calculate lift

activation_platforms*

array of strings

List of activation platforms where to activate the contexutal targeting. For instance ["XANDR"]

{
    "status":"ok",
    "data": {
        "id":"143",
        "segment_id":"128765",
        "volume_ratio":0.33580595,
        "status":"PUBLISHED",
        "activation_platforms":["XANDR"],
        "live_activation_ts":null,
        "last_lift_computation_ts":1676542526247,
        "created_ts":1676542452678,
        "created_by":"3594",
        "last_modified_ts":1676543040147,
        "last_modified_by": "3594",
        "archived":false
    }
}

Archive a contextual targeting

POST https://api.mediarithmics.com/v1/audience_segments/:segmentId/contextual_targetings/:contextualTargetingId/actions

Path Parameters

Name
Type
Description

segmentId*

integer

The ID of the audience segment on which

contextualTargetingId*

Integer

The ID of the contextual targeting retrieved in creation response

Request Body

Name
Type
Description

type*

string

"ARCHIVE"

{
    "status": "ok",
    "data": {
        "id": "143",
        "segment_id": "128765",
        "volume_ratio": 0.33580595,
        "status": "LIVE",
        "activation_platforms": [
            "XANDR"
        ],
        "live_activation_ts": 1676543074426,
        "last_lift_computation_ts": 1676542526247,
        "created_ts": 1676542452678,
        "created_by": "3594",
        "last_modified_ts": 1676548450358,
        "last_modified_by": "3594",
        "archived": true
    }
}

Retrieve all targeting lists

GET https://api.mediarithmics.com/v1/organisations/:organisationId/contextual/targeting_lists

Path Parameters

Name
Type
Description

organisationId*

integer

nFBJ73kqSFqZ

Retrieve targeting list basic information

GET https://api.mediarithmics.com/v1/organisations/:organisationId/contextual/targeting_lists/:targetingListId

Path Parameters

Name
Type
Description

organisationId*

integer

BJ6UpTlOLNNI

targetingListId*

Integer

FTngQkvC50PV

Retrieve semantic targeting list query

GET https://api.mediarithmics.com/v1/organisations/:organisationId/contextual/queries/:queryId

Path Parameters

Name
Type
Description

organisationId*

integer

TuEjdkB1Nk1u

queryId*

Integer

I9n7D5GogQet

Retrieve IAB category information

GET https://api.mediarithmics.com/v1/communities/:communityId/contextual/categories/:categoryId

Path Parameters

Name
Type
Description

communityId*

integer

hG0tA7cmnCka

categoryId*

Integer

TY2S4JsEDPs8

Retrieve entity information

GET https://api.mediarithmics.com/v1/communities/:communityId/contextual/entities/:entityId

Path Parameters

Name
Type
Description

organisationId*

integer

cJqpI1WPpuKA

entityId*

Integer

QAfKQa40qFP1

Retrieve overal metrics for a particular query

POST https://api.mediarithmics.com/v1/communities/:communityId/contextual/analytics/overall_metrics

Path Parameters

Name
Type
Description

organisationId*

integer

A2PVnIzw5J40

Retrieve panel based contextual targeting settings

GET https://api.mediarithmics.com/v1/audience_segments/:segmentId/contextual_targetings

Path Parameters

Name
Type
Description

segmentId*

integer

8h1VucmpDD0b

Publish a contextual targeting (LIVE)

POST https://api.mediarithmics.com/v1/audience_segments/:segmentId/contextual_targetings/:contextualTargetingId/actions

Path Parameters

Name
Type
Description

segmentId*

integer

f0sf54W4oe2N

contextualTargetingId*

Integer

CSE9ce6VGGjD

Request Body

Name
Type
Description

type*

string

fLAbFo3jQnmh

volume_ratio*

float

7R10NbCdVRt0

activation_platforms*

array of strings

Pc6wkm9Cpvoi

Archive a contextual targeting

POST https://api.mediarithmics.com/v1/audience_segments/:segmentId/contextual_targetings/:contextualTargetingId/actions

Path Parameters

Name
Type
Description

segmentId*

integer

fz0W0Y34J4yi

contextualTargetingId*

Integer

Ihj1Jah073n3

Request Body

Name
Type
Description

type*

string

jUR5FyF97PCW

Retrieve all targeting lists

GET https://api.mediarithmics.com/v1/organisations/:organisationId/contextual/targeting_lists

Path Parameters

Name
Type
Description

organisationId*

integer

ezs0TGarYvJ8

Retrieve targeting list basic information

GET https://api.mediarithmics.com/v1/organisations/:organisationId/contextual/targeting_lists/:targetingListId

Path Parameters

Name
Type
Description

organisationId*

integer

T12rF11jMgX0

targetingListId*

Integer

UIzkibsmlO9p

Retrieve semantic targeting list query

GET https://api.mediarithmics.com/v1/organisations/:organisationId/contextual/queries/:queryId

Path Parameters

Name
Type
Description

organisationId*

integer

ekaNM0VztlRN

queryId*

Integer

mQu7yMCLUTRJ

Retrieve IAB category information

GET https://api.mediarithmics.com/v1/communities/:communityId/contextual/categories/:categoryId

Path Parameters

Name
Type
Description

communityId*

integer

e9q4ExXn8sZt

categoryId*

Integer

5lGmUi0TP0eU

Retrieve entity information

GET https://api.mediarithmics.com/v1/communities/:communityId/contextual/entities/:entityId

Path Parameters

Name
Type
Description

organisationId*

integer

bnrHjMNJlETG

entityId*

Integer

qZyZHVkH4b7x

Retrieve overal metrics for a particular query

POST https://api.mediarithmics.com/v1/communities/:communityId/contextual/analytics/overall_metrics

Path Parameters

Name
Type
Description

organisationId*

integer

xEd8N8VYYxpo

Retrieve panel based contextual targeting settings

GET https://api.mediarithmics.com/v1/audience_segments/:segmentId/contextual_targetings

Path Parameters

Name
Type
Description

segmentId*

integer

Pl56yPhTaXIF

Publish a contextual targeting (LIVE)

POST https://api.mediarithmics.com/v1/audience_segments/:segmentId/contextual_targetings/:contextualTargetingId/actions

Path Parameters

Name
Type
Description

segmentId*

integer

VddfsrGUahNx

contextualTargetingId*

Integer

sbmOrcS3O71i

Request Body

Name
Type
Description

type*

string

ez95jrNjrKcV

volume_ratio*

float

7h2DLhamgFwE

activation_platforms*

array of strings

o4Y8gLNyDXxV

Archive a contextual targeting

POST https://api.mediarithmics.com/v1/audience_segments/:segmentId/contextual_targetings/:contextualTargetingId/actions

Path Parameters

Name
Type
Description

segmentId*

integer

PY6egKlkraOU

contextualTargetingId*

Integer

lS6RdioTYNnv

Request Body

Name
Type
Description

type*

string

1SS8Hmo8gdon

PreviousXandr (through prebid.js)NextExporting your data

Last updated 1 year ago

Was this helpful?