====================================================================== Analyses Routes Reference Documentation ====================================================================== .. todo:: Ersetze die HTTP-Domain Extension möglicherweise durch eigene Formatierungen Available analyses ---------------------------------------------------------------------------------- .. http:get:: /analyses List Available Analyses Get a list of all analyses which are available by the underlying MediNET server. :returns: :ref:`REF_MODEL_Analysis` [] (array of :ref:`REF_MODEL_Analysis`) :statuscode 200: Success :statuscode 401: Authentication failed :statuscode 500: Generic error while querying available analyses Analysis information ---------------------------------------------------------------------------------- .. http:get:: /analyses/{analysisId} Get Analysis Information Get information about an individual analysis. :parameter analysisId: string [mandatory] ID of the analysis :returns: :ref:`REF_MODEL_Analysis` :statuscode 200: Success :statuscode 401: Authentication failed :statuscode 403: Access to the requested analysis denied :statuscode 404: Analysis with the provided ID can't be found Get browser ---------------------------------------------------------------------------------- .. http:get:: /analyses/{analysisId}/browse/{nodePath} Traverse Analysis Browser Traverse the "Browser" of an individual analysis. :parameter analysisId: string [mandatory] ID of the analysis. :parameter nodePath: string [optional] Path of browser node. Concatenation of the branch indexes within browser tree. :queryparameter dates: array [optional] List of date intervals :queryparameter depth: integer [optional] Depth to aggregate children of browser nodes :queryparameter lang: string [optional] Language of the display strings of the browser nodes as ISO 639-1 two letter language code. :returns: :ref:`REF_MODEL_BrowserItem` [] (array of :ref:`REF_MODEL_BrowserItem`) :statuscode 200: Success :statuscode 401: Authentication failed :statuscode 403: Access to the requested analysis denied :statuscode 500: Generic error while querying analysis browser Get browser search ---------------------------------------------------------------------------------- .. http:get:: /analyses/{analysisId}/browserSearch Search Analysis Browser Search within the "Browser" of an individual analysis. :parameter analysisId: string [mandatory] ID of the analysis. :queryparameter lang: string [optional] Language of the display strings of the browser nodes as ISO 639-1 two letter language code. :queryparameter where: string [mandatory] Clause to filter browser items. URL encoded JSON object containing name-value pairs of browser item attributes to match. :returns: :ref:`REF_MODEL_BrowserSearchHit` [] (array of :ref:`REF_MODEL_BrowserSearchHit`) :statuscode 200: Success :statuscode 401: Authentication failed :statuscode 403: Access to the requested analysis denied :statuscode 500: Generic error while querying analysis browser Get marketers ---------------------------------------------------------------------------------- .. http:get:: /analyses/{analysisId}/marketers List Marketers Get a list of all marketers of an individual analysis. :parameter analysisId: string [mandatory] ID of the analysis :queryparameter dates: array [optional] List of date intervals :queryparameter where: string [optional] Clause to filter marketers. URL encoded JSON object containing name-value pairs of marketer attributes to match. :returns: :ref:`REF_MODEL_Marketer` [] (array of :ref:`REF_MODEL_Marketer`) :statuscode 200: Success :statuscode 401: Authentication failed :statuscode 403: Access to the requested analysis denied :statuscode 500: Generic error while querying marketers Get media ---------------------------------------------------------------------------------- .. http:get:: /analyses/{analysisId}/media List Media Get a list of all media of an individual analysis. :parameter analysisId: string [mandatory] ID of the analysis :queryparameter dates: array [optional] List of date intervals :queryparameter where: string [optional] Clause to filter media. URL encoded JSON object containing name-value pairs of BrowserMedium attributes to match. :queryparameter ddf_mode: string [optional] Current DDF operation mode key :queryparameter fields: string [optional] Fields to return for all matching media objects. :queryparameter reportStatus: boolean [optional] Provide DDF report status at media. Media are not filtered by report status if doing so :returns: :ref:`REF_MODEL_BrowserMedium` [] (array of :ref:`REF_MODEL_BrowserMedium`) :statuscode 200: Success :statuscode 401: Authentication failed :statuscode 403: Access to the requested analysis denied :statuscode 500: Generic error while querying media Search media ---------------------------------------------------------------------------------- .. http:post:: /analyses/{analysisId}/media/search List Media Get a list of all media of an individual analysis. :parameter analysisId: string [mandatory] ID of the analysis :queryparameter ddf_mode: string [optional] Current DDF operation mode key :jsonparameter parameters: :ref:`REF_MODEL_MediaSearchInput` [mandatory] input parameters for media search :returns: :ref:`REF_MODEL_BrowserMedium` [] (array of :ref:`REF_MODEL_BrowserMedium`) :statuscode 200: Success :statuscode 401: Authentication failed :statuscode 403: Access to the requested analysis denied :statuscode 500: Generic error while querying media Count ---------------------------------------------------------------------------------- .. http: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. :parameter analysisId: string [mandatory] ID of the analysis :queryparameter ddf_mode: string [optional] Current DDF operation mode key :jsonparameter input: :ref:`REF_MODEL_CountInput` [mandatory] Input to be evaluated :returns: :ref:`REF_MODEL_CountResult` :statuscode 200: Success :statuscode 401: Authentication failed :statuscode 403: Access to the requested analysis denied :statuscode 500: Generic error while executing count operation Media Plan ---------------------------------------------------------------------------------- .. http:post:: /analyses/{analysisId}/plan Calculate Media Plan Calculate the provided media plan. :parameter analysisId: string [mandatory] ID of the analysis :queryparameter ddf_mode: string [optional] Current DDF operation mode key :jsonparameter plan: :ref:`REF_MODEL_LegacyPlan` [mandatory] The Media Plan :returns: :ref:`REF_MODEL_CountResult` :statuscode 200: Success :statuscode 401: Authentication failed :statuscode 403: Access to the requested analysis denied :statuscode 500: Generic error while calculating media plan Media Plan Details ---------------------------------------------------------------------------------- .. http:post:: /analyses/{analysisId}/plan-details Calculate Media Plan Details Calculate the details of the provided media plan. :parameter analysisId: string [mandatory] ID of the analysis :queryparameter ddf_mode: string [optional] Current DDF operation mode key :jsonparameter plan: :ref:`REF_MODEL_LegacyPlan` [mandatory] The Media Plan :returns: :ref:`REF_MODEL_PlanDetails` :statuscode 200: Success :statuscode 401: Authentication failed :statuscode 403: Access to the requested analysis denied :statuscode 500: Generic error while calculating media plan Intersections ---------------------------------------------------------------------------------- .. http:post:: /analyses/{analysisId}/evaluations/intersections Calculate Intersections Calculates the intersections of the audiences of a set of media. :parameter analysisId: string [mandatory] ID of the analysis :queryparameter dates: array [optional] List of date intervals :queryparameter ddf_mode: string [optional] Current DDF operation mode key :jsonparameter parameters: :ref:`REF_MODEL_IntersectionsParameters` [mandatory] evaluation specific parameters :returns: :ref:`REF_MODEL_IntersectionsResults` :statuscode 200: Success :statuscode 401: Authentication failed :statuscode 403: Access to the requested analysis denied :statuscode 500: Generic error while calculating intersections