Analyses Routes Reference Documentation

Todo

Ersetze die HTTP-Domain Extension möglicherweise durch eigene Formatierungen

Available analyses

GET /analyses

List Available Analyses

Get a list of all analyses which are available by the underlying MediNET server.

Returns:

Analysis [] (array of Analysis)

Status Codes:

• 200 – Success
• 401 – Authentication failed
• 500 – Generic error while querying available analyses

Analysis information

GET /analyses/{analysisId}

Get Analysis Information

Get information about an individual analysis.

Parameters:

• analysisId – string [mandatory] ID of the analysis

Returns:

Analysis

Status Codes:

• 200 – Success
• 401 – Authentication failed
• 403 – Access to the requested analysis denied
• 404 – Analysis with the provided ID can’t be found

Get browser

GET /analyses/{analysisId}/browse/{nodePath}

Traverse Analysis Browser

Traverse the “Browser” of an individual analysis.

Parameters:

• analysisId – string [mandatory] ID of the analysis.
• nodePath – string [optional] Path of browser node. Concatenation of the branch indexes within browser tree.

Query Parameters:  

• dates – array [optional] List of date intervals
• depth – integer [optional] Depth to aggregate children of browser nodes
• lang – string [optional] Language of the display strings of the browser nodes as ISO 639-1 two letter language code.

Returns:

BrowserItem [] (array of BrowserItem)

Status Codes:

• 200 – Success
• 401 – Authentication failed
• 403 – Access to the requested analysis denied
• 500 – Generic error while querying analysis browser

Get browser search

GET /analyses/{analysisId}/browserSearch

Search Analysis Browser

Search within the “Browser” of an individual analysis.

Parameters:

• analysisId – string [mandatory] ID of the analysis.

Query Parameters:  

• lang – string [optional] Language of the display strings of the browser nodes as ISO 639-1 two letter language code.
• where – string [mandatory] Clause to filter browser items. URL encoded JSON object containing name-value pairs of browser item attributes to match.

Returns:

BrowserSearchHit [] (array of BrowserSearchHit)

Status Codes:

• 200 – Success
• 401 – Authentication failed
• 403 – Access to the requested analysis denied
• 500 – Generic error while querying analysis browser

Get marketers

GET /analyses/{analysisId}/marketers

List Marketers

Get a list of all marketers of an individual analysis.

Parameters:

• analysisId – string [mandatory] ID of the analysis

Query Parameters:  

• dates – array [optional] List of date intervals
• where – string [optional] Clause to filter marketers. URL encoded JSON object containing name-value pairs of marketer attributes to match.

Returns:

Marketer [] (array of Marketer)

Status Codes:

• 200 – Success
• 401 – Authentication failed
• 403 – Access to the requested analysis denied
• 500 – Generic error while querying marketers

Get media

GET /analyses/{analysisId}/media

List Media

Get a list of all media of an individual analysis.

Parameters:

• analysisId – string [mandatory] ID of the analysis

Query Parameters:  

• dates – array [optional] List of date intervals
• where – string [optional] Clause to filter media. URL encoded JSON object containing name-value pairs of BrowserMedium attributes to match.
• ddf_mode – string [optional] Current DDF operation mode key
• fields – string [optional] Fields to return for all matching media objects.
• reportStatus – boolean [optional] Provide DDF report status at media. Media are not filtered by report status if doing so

Returns:

BrowserMedium [] (array of BrowserMedium)

Status Codes:

• 200 – Success
• 401 – Authentication failed
• 403 – Access to the requested analysis denied
• 500 – Generic error while querying media

Search media

POST /analyses/{analysisId}/media/search

List Media

Get a list of all media of an individual analysis.

Parameters:

• analysisId – string [mandatory] ID of the analysis

Query Parameters:  

• ddf_mode – string [optional] Current DDF operation mode key

JSON Parameters:  

• parameters – MediaSearchInput [mandatory] input parameters for media search

Returns:

BrowserMedium [] (array of BrowserMedium)

Status Codes:

• 200 – Success
• 401 – Authentication failed
• 403 – Access to the requested analysis denied
• 500 – Generic error while querying media

Count

POST /analyses/{analysisId}/count

Count Audiences or Query Performance Data of Media

Query a statistical count result of audiences or performance data of media provided by HTTP body parameters.

Parameters:

• analysisId – string [mandatory] ID of the analysis

Query Parameters:  

• ddf_mode – string [optional] Current DDF operation mode key

JSON Parameters:  

• input – CountInput [mandatory] Input to be evaluated

Returns:

CountResult

Status Codes:

• 200 – Success
• 401 – Authentication failed
• 403 – Access to the requested analysis denied
• 500 – Generic error while executing count operation

Media Plan

POST /analyses/{analysisId}/plan

Calculate Media Plan

Calculate the provided media plan.

Parameters:

• analysisId – string [mandatory] ID of the analysis

Query Parameters:  

• ddf_mode – string [optional] Current DDF operation mode key

JSON Parameters:  

• plan – LegacyPlan [mandatory] The Media Plan

Returns:

CountResult

Status Codes:

• 200 – Success
• 401 – Authentication failed
• 403 – Access to the requested analysis denied
• 500 – Generic error while calculating media plan

Media Plan Details

POST /analyses/{analysisId}/plan-details

Calculate Media Plan Details

Calculate the details of the provided media plan.

Parameters:

• analysisId – string [mandatory] ID of the analysis

Query Parameters:  

• ddf_mode – string [optional] Current DDF operation mode key

JSON Parameters:  

• plan – LegacyPlan [mandatory] The Media Plan

Returns:

PlanDetails

Status Codes:

• 200 – Success
• 401 – Authentication failed
• 403 – Access to the requested analysis denied
• 500 – Generic error while calculating media plan

Intersections

POST /analyses/{analysisId}/evaluations/intersections

Calculate Intersections

Calculates the intersections of the audiences of a set of media.

Parameters:

• analysisId – string [mandatory] ID of the analysis

Query Parameters:  

• dates – array [optional] List of date intervals
• ddf_mode – string [optional] Current DDF operation mode key

JSON Parameters:  

• parameters – IntersectionsParameters [mandatory] evaluation specific parameters

Returns:

IntersectionsResults

Status Codes:

• 200 – Success
• 401 – Authentication failed
• 403 – Access to the requested analysis denied
• 500 – Generic error while calculating intersections