openapi: 3.0.0
x-stoplight:
  id: bmaieg1p7ctvh
info:
  version: ''
  contact:
    name: API Support
    url: https://www.mediamath.com/contact-us/
    email: support@mediamath.com
  title: Reporting API V1
  description: >
    {% admonition type="danger" name="This API is deprecated and will be removed
    in July 2026" %}
      The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
    {% /admonition %}


    {% admonition type="warning" name="Notice about authentication with cookie
    adama_session" %}
      The use of cookie adama_session for authentication has been discontinued and it's not supported in Reporting API V2. 
      We ask all of our clients who have not yet migrated to [OAuth2 Authentication](https://apidocs.mediamath.com/guides/authentication) to do so as soon as possible.
    {% /admonition %}


    The Reports API on MediaMath Platform allows advertisers to access, query
    and aggregate reporting data.  It is also the API that powers all reporting
    seen on our MediaMath Platform flagship UI.


    The Reports API offers a number of reports.  Each report offers its own
    pre-aggregated, time-based metrics on entities that users can query.  A
    query can filter, aggregate, sort, paginate, and format this data.


    It is a read-only system meaning no request against it can alter the data in
    any way.


    It is also a metadata-driven system.  The supported reports are described in
    a human- and machine-readable format.  This ensures easy one-off and
    repeatable programmatic data querying.  It also provides a way for clients
    to adapt to changes in reports programmatically.  This gives
    client-developers the ability to create UIs that provide useful operational
    feedback in a navigable and understandable way.  


    The $API_BASE for the latest version of Reports API is
    `https://api.mediamath.com/reporting/v1/std`


    ## Authentication


    See [OAuth
    Authentication](https://apidocs.mediamath.com/guides/authentication)


    ## Fields


    Report data is stored and output in a tabular format.  This means that the
    output consists of rows and columns.  Every row has a value for every
    column.


    The `structure` object can be used to determine the columns a report can
    output.  Its fields are divided among three mappings - `time_field`,
    `dimensions`, and `metrics`.  Each mapping, maps field name to
    #model:Fqbi8siNTuFGqA2W5.


    ```json

    {
      
      "time_rollups" : [ "by_day", "by_week", "by_month", "all" ],
      "time_windows" : [ "yesterday", "last_X_days", "month_to_date", "campaign_to_date" ],
      "timezone" : "campaign timezone",
      "time_aggregation" : "by_day",
      "structure" : { 
        "time_field" : { 
          "date" : { 
            "name" : "Date",
            "type" : "datetime"
          }
        },  
        "dimensions" : {
          "campaign_id" : { ... },
          "campaign_name" : { ... },
          "strategy_id" : { ... },
          "strategy_name" : { ... }
        },  
        "metrics" : { 
          "clicks" : { ... },
          "impressions" : { ... }
        }
      }
      ...
    }

    ```


    ### Time Field


    The time field represents the time-component of the report's metrics.  There
    is (currently) only one time field for each report.  It can be of one of
    these data types: `datetime` or `interval`.  Its data type determines the
    type of report (**datetime** or **interval** based report).


    **Note:** The type of report is not to be confused with the `Type`
    attribute.  The `Type` attribute is purely informational.


    The time field was distinguished from the dimension fields to allow its use
    in grouping and filtering rows easier to understand.  It gets its own set of
    parameters and language.


    #### datetime-typed Time Fields


    Datetime-typed time fields contains a combination of year, month, day, and
    possibly down to hour, minute and second.  The `time_aggregation` property
    indicates the field's finest grain (by_hour, by_day, etc).  The
    `time_rollups` property indicates the available grouping options that can go
    beyond the `time_aggregation` of the report.


    ```

    time_rollup=by_week     ### group rows by the week  -  week starts on
    Monday 

    time_rollup=by_month    ### group rows by the month

    time_rollup=all         ### produces at most one row of output per
    combination of dimension fields
                            ### listed in the dimensions parameter
    ```


    The time field for these reports are typically represented in the output by
    a start_date and end_date column.  The format of the column will depend on
    the time window and `time_rollup`.


    * YYYY-MM-DD

    * YYYY-MM-DD hh:mi:ss


    The only exception to this rule is detailed in the Special Time Windows
    section.


    The timezone of the start_date and end_date columns will match the
    `timezone` property.


    #### interval-typed Time Fields


    `interval`-typed time fields, contain a predefined non-calendar date based
    aggregation (1 day, 7 days, 30 days, and so on).  In this case, the only
    accepted way to specify a time interval is by using the parameter
    `time_window`.  The only value supported for the parameter `time_rollup` for
    interval-based reports is `all`.


    The time field for these reports are represented in the output by a interval
    column.  The value of the column will depend on the `time_window` chosen. 
    The following gives example column values based on the time_window.


    * yesterday - 1

    * last_7_days - 7

    * last_30_days - 30

    * campaign_to_date - CTD

    * flight_to_date - FTD


    #### Filtering with the Time Field


    The API requires the specification of a time window in order to narrow the
    data set operated on. A time window must be specified in one of the two
    possible ways.


    * `start_date` and `end_date` (optional - defaults to "yesterday").

    * `time_window` may be set to one of the formats defined by the
    `time_windows` attribute.


    ```

    ###  operate on data timestamped between Jan 01, 2013 and Feb 01, 2013,
    inclusive

    start_date=2013-01-01&end_date=2013-02-01  

    ###  operate on data timestamped between May 05, 2013 and yesterday,
    inclusive

    start_date=2013-05-01  

    ###  other usage examples 

    time_window=last_30_days 

    time_window=month_to_date 

    time_window=yesterday 

    ```


    ##### start_date and end_date


    `start_date` and `end_date` may only be used when the report's time field is
    of the `datetime` type.  They may not be used when the report's time field
    is of the `interval` data type.  This is because the `time_windows` are
    pre-defined intervals that cannot be split.


    The `start_date` and `end_date` parameters define inclusive boundaries for
    the data.  In order to ease the burden of calculating an inclusive end, the
    inputs may be specified at various granularities.


    *   month - YYYY-MM

    *   day - YYYY-MM-DD

    *   hour - YYYY-MM-DDThh

    *   minute - YYYY-MM-DDThh:mi

    *   second - YYYY-MM-DDThh:mi:ss


    Each granularity matches a substring of the ISO 8601 format.


    If the report is at a coarser granularity (see `time_aggregation`) than the
    input, the input will be taken to mean the entirety of the time unit.


    ```

    start_date=2016-04-12T01%3A30%3A00&end_date=2016-04-12T02%3A30%3A00

    # ie. start_date=2016-04-12T01:30:00&end_date=2016-04-12T02:30:00

    # For a report with a time_aggregation of by_hour:

    # 2016-04-12T01:00:00 to 2016-04-12T02:59:59.
     
    # For a report with a time_aggregation of by_day:

    # 2016-04-12T00:00:00 to 2016-04-12T23:59:59

    ```


    ##### time_window


    All values mentioned in the `time_windows` array will be accepted verbatim
    by the time_window parameter with the exception of any time window that
    starts with `last_X_`.  They may be interpreted as such.


    * The `last_X_days` time window ends yesterday (inclusive) and starts X days
    before that.

    * The `last_X_hours` time window ends at the previous hour (inclusive) and
    starts X hours before that.


    Future windows of this type may be defined following this nomenclature, but
    for different units.  Rules for the time window may vary slightly.


    ##### Special Time Windows


    The following `time_windows` are considered to be special time windows.


    * `campaign_to_date`

    * `flight_to_date`


    For reports with a `datetime`-typed `time_field`, the start_date and
    end_date columns that would normally be present, will be replaced by the
    interval column. Additionally, the following validation rules apply when a
    special `time_window` is chosen.


    * The results will have an `interval` column instead of `start_date` and
    `end_date` columns.

    * The `time_rollup` parameter must be set to `all`.

    * Any mention of the `time_field` for the report in the `order` parameter
    will be rejected.


    ### Dimension Fields


    Dimension fields describe an entity.  The example reports provide dimension
    fields for campaign, and strategy entities.  Dimension fields are used to
    group rows during aggregation in conjunction with the time field.


    ### Metric Fields


    Once the rows have been grouped.  The metric fields are calculated based on
    the values of the group's underlying rows.  These calculations are generally
    sums or averages.  These fields are usually a numeric data type.


    Please note that fees (eg: managed_service_fee, optimization_fee,
    platform_access_fee, and mm_total_fee), cost (eg: adserving_cost,
    adverification_cost, media_cost, and tota_ad_cost), and margin data are only
    available to users who have “edit margin” access.


    # Data Types


    The `id` type allows any character except whitespace.


    The `datetime` type may be filtered by dates, or datetimes in either of the
    following ISO 8601 based formats.


    *   date - YYYY-MM-DD

    *   datetime - YYYY-MM-DDThh:mi:ss


    Year, month, and day are all 1-based.  Hour, minute, and second are all
    0-based.  Valid hours are 0-23.


    The dimension fields of the `datetime` type will always be output in the
    aforementioned datetime format.  The output columns for the time field will
    be output in the same format, but without the separating 'T'.


    ### Field Data Type Groupings


    This documentation may refer to multiple data types via a group name.  The
    following table details the group names.


    |Group|Data Types|

    |--- |--- |

    |float|float, money, percent, ratio|

    |integer|integer, count, rank|

    |numeric|float and integer groups|

    |date|datetime|

    |string|string, interval|

    |id|id|

    |bool|bool, boolean|
  license:
    url: http://www.apache.org/licenses/LICENSE-2.0.html
    name: Apache 2.0
paths:
  /meta:
    get:
      operationId: GET_meta
      summary: Reports List
      tags:
        - Metadata
      description: >-
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        In order to obtain a list of reports which are currently supported by
        the Reports API, issue the following API call:


        `$API_BASE/meta`


        All metadata in Reports API is represented in JSON format (content-type:
        application/json; charset=UTF-8).  The schema for the response follows
        the example.


        ## Reports Meta


        The example has been formatted for easy reading.


        ``` json

        {
            "reports": {
                "app_transparency": {
                    "Description": "Standard performance metrics broken out by App ID. Non-app inventory shown as N/A app_id",
                    "Name": "App Transparency Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/app_transparency",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/app_transparency/meta",
                    "Version": 1
                },
                "audience_index": {
                    "Description": "Special index metrics for comparing your ads' viewers to 3rd party segments.  Broken out by audience name, as well as standard dimensions down to campaign and strategy.  Currently available in one interval: last 14 days.",
                    "Name": "Audience Index Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/audience_index",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/audience_index/meta",
                    "Version": 1
                },
                "audience_index_pixel": {
                    "Description": "Special index metrics for comparing your site visitors to 3rd party segments.  Broken out by audience name and pixel.  Currently available in one interval: last 14 days.",
                    "Name": "Audience Index Pixel Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/audience_index_pixel",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/audience_index_pixel/meta",
                    "Version": 1
                },
                "by_hour": {
                    "Description": "Standard performance metrics broken out by standard dimensions, available in precise time windows - down to the hour - with the option to aggregate by hour or day.",
                    "Name": "By Hour Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/by_hour",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/by_hour/meta",
                    "Version": 1
                },
                "contextual_insights": {
                    "Description": "Standard performance metrics broken out by contextual categories that strategies are targeting",
                    "Name": "Contextual Insights",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/contextual_insights",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/contextual_insights/meta",
                    "Version": 1
                },
                "data_pixel_loads": {
                    "Description": "Loads and Uniques metrics for data pixels, broken out by referrer and referrer rank, available by day.",
                    "Name": "Data Pixel Loads Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/data_pixel_loads",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/data_pixel_loads/meta",
                    "Version": 1
                },
                "day_part": {
                    "Description": "Standard performance metrics broken out by time of day and day of week. Available in standard intervals.",
                    "Name": "Day Part Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/day_part",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/day_part/meta",
                    "Version": 2
                },
                "device_technology": {
                    "Description": "Standard performance metrics broken out by technology dimensions including browser, operating system, and connection type.  Available in custom date ranges or intervals with the option to aggregate by day, week, or month.",
                    "Name": "Device Technology Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/device_technology",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/device_technology/meta",
                    "Version": 1
                },
                "event_pixel_loads": {
                    "Description": "Loads and Uniques metrics for event pixels, broken out by referrer and referrer rank, available by day.",
                    "Name": "Event Pixel Loads Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/event_pixel_loads",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/event_pixel_loads/meta",
                    "Version": 1
                },
                "geo": {
                    "Description": "Standard performance metrics broken out by geographic dimensions including country, region, and metro area.  Available in standard intervals.",
                    "Name": "Geo Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/geo",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/geo/meta",
                    "Version": 2
                },
                "hyperlocal": {
                    "Description": "Standard performance metrics broken out by Hyperlocal Targeting objects created via third party.",
                    "Name": "Hyperlocal Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/hyperlocal",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/hyperlocal/meta",
                    "Version": 1
                },
                "performance": {
                    "Description": "Standard performance metrics in campaign currency and broken out by our widest array of dimensions.  Available in custom date ranges or intervals with the option to aggregate by day, week, or month.",
                    "Name": "Performance Report in Campaign Currency",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/performance",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/performance/meta",
                    "Version": 1
                },
                "postal_code": {
                    "Description": "Standard performance metrics broken out by postal code. Only includes data for strategies that targeted or anti-targeted postal codes. Available in custom date ranges or intervals with the option to aggregate by day, week, or month.",
                    "Name": "Postal Code Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/postal_code",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/postal_code/meta",
                    "Version": 1
                },
                "reach_frequency": {
                    "Description": "Basic performance metrics as well as the \"uniques\" metric, broken out by frequency of ad exposure.  Available in standard intervals.",
                    "Name": "Reach and Frequency Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/reach_frequency",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/reach_frequency/meta",
                    "Version": 1
                },
                "site_transparency": {
                    "Description": "Standard performance metrics broken out by the domain of the inventory.  Available in standard intervals.",
                    "Name": "Site Transparency Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/site_transparency",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/site_transparency/meta",
                    "Version": 2
                },
                "video": {
                    "Description": "Video-specific metrics such as completion rate, skips, and fullscreens broken out by a wide array of dimensions.  Available in custom date-ranges or intervals with the option to aggregate by day, week, or month.",
                    "Name": "Video Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/video",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/video/meta",
                    "Version": 1
                },
                "watermark": {
                    "Description": "Watermark metrics show how many impressions and how much spend went towards the brain's learning activities.  Viewable by campaign and strategy dimensions and available by day.",
                    "Name": "Watermark Report in US Dollars",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/watermark",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/watermark/meta",
                    "Version": 1
                },
                "win_loss": {
                    "Description": "Metrics describe the auction before a win or even a bid has taken place.  Broken out by strategy, exchange, and deal dimensions and available by hour.",
                    "Name": "Win/Loss Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/win_loss",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/win_loss/meta",
                    "Version": 2
                },
                "win_loss_creative": {
                    "Description": "Metrics describe the auction before a win has taken place. Broken out by creative dimensions and available by hour.",
                    "Name": "Win/Loss Creative Report",
                    "URI_Data": "https://api.mediamath.com/reporting/v1/std/win_loss_creative",
                    "URI_Meta": "https://api.mediamath.com/reporting/v1/std/win_loss_creative/meta",
                    "Version": 1
                }
            }
        }


        ```
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/reports-list'
  /{report}/meta:
    parameters:
      - name: report
        in: path
        description: >-
          This must be a report discoverable from
          https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_meta.
        required: true
        schema:
          type: string
    get:
      operationId: GET_report-meta
      summary: Report Meta
      tags:
        - Metadata
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        The examples used in this section are truncated versions of
        <https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta>. 

        The use of "..." in an example is meant to indicate truncation of other
        properties.  The Definition section of this endpoint provides
        information 

        about how the metadata may vary from report to report.  The Definition
        section of the
        <https://apidocs.mediamath.com/apis/reporting-api-v1/data-retrieval/get_report> 

        provides a reference to the query string parameters that it accepts.
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/full-report-description'
  /{report}:
    parameters:
      - name: report
        in: path
        description: >
          {% admonition type="danger" name="This API is deprecated and will be
          removed in July 2026" %}
            The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
          {% /admonition %}


          This must be a report discoverable from
          https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_meta.
        required: true
        schema:
          type: string
    get:
      operationId: GET_report
      summary: Report Data
      tags:
        - Data Retrieval
      description: >-
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        # Parameters


        Parameter names are case sensitive, (see the table below).


        Most parameters will fall under one of the following two formats.


        *   enumeration of comma-separated items (used in aggregation, selection
        and sorting);
            *   example:
                *   `dimensions=campaign_id%2Ccampaign_name%2Ccampaign_start_date` (in other words, `campaign_id,campaign_name,campaign_start_date`)
        *   list of logically AND-ed expressions, joined by ampersand (used in
        dimension and metric filtering);
            *   examples:
                *   `filter=campaign_id%3D12345%26strategy_id%3D98765` (in other words, `campaign_id=12345&strategy_id=98765`)
                *   `having=impressions%3E%3D500%26clicks%3C100` (in other words, `impressions>=500&clicks<100`)

        # Query Options


        A query can filter, aggregate, sort, paginate, and format a report's
        data.


        Filtering is required.  It must be done on the time field, and one or
        more dimension fields that have their `access` property set to true.  It
        can be done both before and after aggregation.


        Aggregation, like filtering, is also required.  The grouping must be
        performed against the time field and a combination of one or more
        dimension fields.


        Sorting, pagination, and formatting are not required.  The features are
        controlled via the `order`, `page_limit`, `page_offset`, and `precision`
        parameters.  They are described in full detail in the Definition section
        at the end of the documentation for this endpoint.


        ### Filtering


        Data filtering may be performed before rows are grouped, and afterwards
        as well.


        It can be done before grouping via the `time_window`, `start_date`,
        `end_date`, and `filter` parameters.  This provides finer control over
        what rows contribute to the metric fields of a group.


        Filtering can also be done after grouping, and metric calculations via
        the `having` parameter.


        For more information about the `time_window`, `start_date`, and
        `end_date` parameters see the
        <https://apidocs.mediamath.com/apis/reporting-api-v1/section/fields>
        section.


        For more information about the `filter` and `having` parameters see the
        following section.


        #### Predicate Parameters


        `filter` and `having` are predicate parameters.  One of the two
        parameters is required.  The parameters consist of one or more
        predicates.  A predicate has the following format.


        1.  a dimension or metric field from the report definition

        2.  an operator from the _Operators supported in filtering expressions_
        table

        3.  one or more values matching the type of field


        At least one predicate parameters is required.  This is because at least
        one of the predicates must use one of the access dimension fields in an
        equality test (operator `=`).


        The `filter` parameter filters on dimension fields only, while the
        `having` parameter may filter by both dimension and metric fields.  The
        `filter` parameter is applied before rows are grouped, while the
        `having` parameter is applied after rows have been grouped, and metrics
        have been calculated.


        The parameter `filter` is not required if access dimension fields are
        used in parameter `having`.  Using dimension fields in the `having`
        parameter causes those dimension fields to be used in grouping rows.


        ##### Operators supported in filtering expressions


        |Operators|Operation|Field Data Type|

        |--- |--- |--- |

        |=, !=|equality, non-equality check|all|

        |>, <, >=, <=|inequality check|numeric|

        |~, =~|contains, case sensitive|string|

        |=:|contains, case insensitive|string|

        |!~|does not contain, case sensitive|string|

        |!:|does not contain, case insensitive|string|


        ##### Multiple Predicates


        More than one predicate may be specified in a predicate parameter.  The
        predicates need to be joined together with an ampersand (&).  The
        ampersand indicates the predicates are ANDed together.  As such, for a
        record to appear in the results, each predicate must evaluate to true
        for that record.  The following shows an example.


        ```

        ###  filtering aggregated rows by metric or dimension fields

        having=impressions%3E%3D500%26clicks%3C100%26campaign_id%3D12345

        ###  (i.e.  impressions>=500&clicks<100&campaign_id=12345)


        ###  filtering base rows by dimension fields

        filter=campaign_id%3D12345%26strategy_id%3D98765%2Cstrategy_goal_type%3Dcpc

        ###  (i.e.  campaign_id=12345&strategy_id=98765&strategy_goal_type=cpc)

        ```


        ##### Predicates with Multiple Values


        A predicate is considered true, if one or more values evaluate as true
        for the given field and comparison operation.  This result is then ANDed
        with any other predicates that exist at that level of filtering.  Values
        must be separated by commas.  The following shows an example.


        ```

        ### filtering records for when campaign_id is 11111, 22222, or 33333 and
        the campaign_name contains "sell"

        filter=campaign_id%3D11111%2C22222%2C33333%26campaign_name%7Esell

        ###  (i.e.  campaign_id=11111,22222,33333&campaign_name~sell)

        ```


        ##### Encoding Predicates


        In order to ensure predicates and values are properly separated, a
        special encoding is needed for predicate values that contain any of the
        following characters.


        & , " < > = ~ ! :


        The encoding is a simple two step process.


        1.  Double quotes are doubled.

        2.  The resultant value is surrounded in double quotes.


        The following shows an example.


        *   Unencoded: Jack & Jill "Of All Trades"

        *   Encoded: "Jack & Jill ""Of All Trades"""


        This special encoding may be applied to any value in the predicates.  It
        does not determine the type. The looseness is there to allow for URLs to
        be more readable.  It does however, need to be applied before URL
        encoding is performed.


        ### Aggregation


        Through the `dimensions`, one can indicate the way the rows must be
        grouped. One or more dimension fields, may be specified. The order in
        which the dimension fields are listed is important for the result set.


        ```

        ###  group by these fields in this order
        dimensions=campaign_id%2Ccampaign_name%2Ccampaign_start_date

        ###  (i.e.  campaign_id,campaign_name,campaign_start_date) 

        ```


        See the Time Field section of the
        <https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta>
        for grouping options available for the time field.


        Grouping by metric fields is not allowed.  Metric fields are calculated
        based on the underlying rows of each group.  The metrics can be chosen
        via the `metrics` parameter.


        ```

        ###  calculate these metrics per group dimensions=clicks%2Cimpressions

        ###  (i.e.  clicks,impressions) 

        ```


        # On Success


        The system returns an appropriate HTTP return code (2xx or 3xx - see
        [RFC
        2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1.1)).
        The response body is CSV-formatted (`Content-Type: text/csv`),
        consisting of one header row, and zero or more data rows. The response
        uses the HTTP 1.1
        [chunking](http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6.1)
        feature.


        A data row will represent a group.  It will have a start_date/end_date
        format, or an interval format.  Always use the header line to determine
        the order of columns, as they may not match the order listed in the
        parameters.


        ### start_date/end_date Format


        * two columns of type datetime:
           * start_date - the start of the time rollup interval (inclusive)
           * end_date - the end of the time rollup interval (inclusive)
        * all dimension fields specified in the parameters dimensions

        * all metric fields specified in the parameter metrics

        * all fields, dimension or metric, specified in the parameters having
        and order


        Note that the `start_date` and `end_date` will cover the whole interval
        specified by the parameter time_window (or `start_date` \/ `end_date`
        equivalents), or the intervals generated according to the parameter
        `time_rollup`, even though data may not exist for the whole interval.


        ```

        start_date,end_date,campaign_id,campaign_name,creative_id,creative_name,clicks,impressions,total_spend

        "2013-05-01","2013-05-22",123456,"My Campaign Nr 10",98765432,"Creative
        No 12",17701,171981779,45266.65

        "2013-04-24","2013-04-30",123456,"My Campaign Nr 10",11223344,"Creative
        Nr Five",4101,45076933,7566.57

        "2013-04-24","2013-04-30",123456,"My Campaign Nr 10",12121212,"Creative
        Ten",5220,42592353,6360.86

        "2013-05-01","2013-05-22",123456,"My Campaign Nr 10",99887766,"Creative
        One",21912,41691908,61644.34 

        ```


        ### interval Format


        * one field of type interval:
           * interval - the pre-aggregated interval of the group.
        * all dimension fields specified in the parameters dimensions

        * all metric fields specified in the parameter metrics

        * all fields, dimension or metric, specified in the parameters having
        and order


        ```

        interval,campaign_id,campaign_name,creative_id,creative_name,clicks,impressions,total_spend

        7,123456,"My Campaign Nr 10",98765432,"Creative No
        12",17701,171981779,45266.65

        7,123456,"My Campaign Nr 10",11223344,"Creative Nr
        Five",4101,45076933,7566.57

        7,123456,"My Campaign Nr 10",12121212,"Creative
        Ten",5220,42592353,6360.86

        7,123456,"My Campaign Nr 10",99887766,"Creative
        One",21912,41691908,61644.34 

        ```


        ### Predicting the Format


        `interval` based report queries will return the interval format.


        `datetime` based report queries:

        * using a special time window will return the interval format.

        * using a normal time window will return the start_date/end_date format.


        # On Error


        On error, an appropriate HTTP status code is returned (4xx or 5xx - see
        [RFC
        2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1.1)).
        The response body, which of type XML (`Content-Type: text/xml`) will
        contain, at the minimum (see examples below), the root element result,
        with at least one element named status, which in turn has an attribute
        named code, and a human readable text. Some error responses also contain
        an attribute reason, which adds more information regarding the error.


        There are several types of errors:


        ### Authentication and authorization errors


        ```

        HTTP/1.0 401 Unauthorized

        Content-Type: text/xml; charset=UTF-8


        <result>
          <status code="auth_required" reason="not_logged_in">Authentication Required</status>
        </result>

        ```


        ```

        HTTP/1.0 403 Forbidden

        Content-Type: text/xml; charset=UTF-8


        <result>
          <entity id="12345" type="campaign" />
          <status code="denied">Insufficient permissions</status>
        </result>

        ```


        ### Parameter validation errors (malformed values, unknown fields,
        missing required parameters, etc)


        ```

        HTTP/1.0 400 Bad Request

        Content-Type: text/xml; charset=UTF-8


        <result>
          <status code="bad_request" reason="missing_time_window">a time window is required</status>
        </result>

        ```


        ### Non-existent entities


        ```

        HTTP/1.0 404 Not Found

        Content-Type: text/xml; charset=UTF-8


        <result>
          <entity id="12345" type="campaign" />
          <status code="not_found">Entity Not Found</status>
        </result>

        ```


        ### Server errors (internal error, request timeout, scheduled
        maintenance, server overloaded)


        ```

        HTTP/1.0 500 Internal Server Error

        Content-Type: text/xml; charset=UTF-8


        <result>
          <status code="error">Internal Server Error</status>
        </result>

        ```


        ```

        HTTP/1.0 500 Internal Server Error

        Content-Type: text/xml; charset=UTF-8


        <result>
          <status code="request_timeout">The request timed out</status>
        </result>

        ```


        ```

        HTTP/1.0 503 Service Unavailable

        Content-Type: text/xml; charset=UTF-8


        <result>
          <status code="unavailable">The server is temporarily unavailable due to maintenance downtime.</status>
        </result>

        ```
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
  /{report}/validate:
    parameters:
      - name: report
        in: path
        required: true
        description: >-
          This must be a report discoverable from
          https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta.
        schema:
          type: string
    get:
      operationId: GET_report-validate
      summary: Validate Report Data Request
      tags:
        - Data Retrieval
      description: >-
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        ### Validating Data Retrieval Requests


        Data retrieval requests can be validated and authenticated without
        actually requesting data, by simply appending a `/validate` path segment
        to the URI. **Important:** The validation process takes into account the
        current user's permissions. The error responses that are returned in
        case of validation failure are the same as the ones that would have been
        returned by the regular API call.


        The following shows an example validation request for a request with an
        erroneous `organization_id` filtering parameter:


        ```

        GET
        /reporting/v1/std/{report}/validate?filter=organization_id%3D12345&dimensions=campaign_id%2Corganization_id&time_window=last_7_days&time_rollup=by_day

        ```


        ```

        HTTP/1.0 404 Not Found

        Content-Type: text/xml; charset=UTF-8


        <?xml version='1.0' ?>

        <result>
          <entity id="12345" type="organization" />
          <status code="not_found">Entity Not Found</status>
        </result>

        ```


        By contrast, this call shows a validation response for a valid call:


        ```

        GET
        /reporting/v1/std/{report}/validate?filter=organization_id%3D12346&dimensions=campaign_id%2Corganization_id&time_window=last_7_days&time_rollup=by_day

        ```


        ```

        HTTP/1.0 200 OK

        Content-Type: text/xml; charset=UTF-8


        <?xml version='1.0' ?>

        <result>
          <status code="ok" />
        </result>

        ```
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
  /app_transparency:
    get:
      operationId: GET_app_transparency
      summary: App Transparency
      tags:
        - Reports
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        See or query the Meta Endpoint for required fields and parameters.
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema: {}
  /app_transparency/meta:
    get:
      operationId: GET_app_transparency-meta
      summary: App Transparency Meta
      tags:
        - Reports
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                type: object
                properties:
                  Description:
                    type: string
                    description: >-
                      Standard performance metrics in campaign currency and
                      broken out by our widest array of dimensions.  Available
                      in custom date ranges or intervals with the option to
                      aggregate by day, week, or month.
                  Name:
                    type: string
                    description: Performance Report in Campaign Currency
                  Type:
                    type: string
                  URI_Data:
                    type: string
                    default: https://api.mediamath.com/reporting/v1/std/performance
                  URI_Meta:
                    type: string
                    default: >-
                      https://api.mediamath.com/reporting/v1/std/performance/meta
                  Version:
                    type: integer
                  currency:
                    type: string
                    description: campaign currency
                  data_retention:
                    type: string
                  default_metrics:
                    type: array
                    items:
                      type: string
                  structure:
                    type: object
                    properties:
                      dimensions:
                        type: object
                        properties:
                          advertiser_id:
                            type: object
                            properties:
                              access:
                                type: boolean
                              name:
                                type: string
                              type:
                                type: string
                          advertiser_name:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                          agency_id:
                            type: object
                            properties:
                              access:
                                type: boolean
                              name:
                                type: string
                              type:
                                type: string
                          agency_name:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                          app_id:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                          attribution_group:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                              values:
                                type: array
                                items:
                                  type: string
                          campaign_budget:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          campaign_currency_code:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          campaign_end_date:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          campaign_goal_type:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                              values:
                                type: array
                                items:
                                  type: string
                          campaign_goal_value:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          campaign_id:
                            type: object
                            properties:
                              access:
                                type: boolean
                              name:
                                type: string
                              type:
                                type: string
                          campaign_initial_start_date:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          campaign_name:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                          campaign_start_date:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          campaign_timezone:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          campaign_timezone_code:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          exchange_id:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          exchange_name:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                          organization_id:
                            type: object
                            properties:
                              access:
                                type: boolean
                              name:
                                type: string
                              type:
                                type: string
                          organization_name:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                          strategy_budget:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          strategy_channel:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                              values:
                                type: array
                                items:
                                  type: string
                          strategy_end_date:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          strategy_goal_type:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                              values:
                                type: array
                                items:
                                  type: string
                          strategy_goal_value:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          strategy_id:
                            type: object
                            properties:
                              access:
                                type: boolean
                              name:
                                type: string
                              type:
                                type: string
                          strategy_name:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                          strategy_start_date:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          strategy_supply_type:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                              values:
                                type: array
                                items:
                                  type: string
                          strategy_type:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                      metrics:
                        type: object
                        properties:
                          clicks:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          ctc:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          ctr:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          impressions:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          media_cost:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          media_cost_cpa:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          media_cost_cpc:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          media_cost_cpm:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          media_cost_pc_cpa:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          media_cost_pv_cpa:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          post_click_conversions:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          post_view_conversions:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          rr_per_1k_imps:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          total_ad_cost:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          total_ad_cost_cpa:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          total_ad_cost_cpc:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          total_ad_cost_cpm:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          total_ad_cost_pc_cpa:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          total_ad_cost_pv_cpa:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          total_conversions:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          total_spend:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          total_spend_cpa:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          total_spend_cpc:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          total_spend_cpm:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          total_spend_pc_cpa:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          total_spend_pv_cpa:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_close:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_collapse:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_companion_clicks:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_companion_ctr:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_companion_impressions:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_complete:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_complete_rate:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_engaged_impressions:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_engaged_rate:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_expand:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_first_quartile:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_first_quartile_rate:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_fullscreen:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_midpoint:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_midpoint_rate:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_mute:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_pause:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_play_rate:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_resume:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_rewind:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_skip:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_skippable_impressions:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_skipped_impressions:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_skipped_rate:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_start:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_third_quartile:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_third_quartile_rate:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          video_unmute:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                      time_field:
                        type: object
                        properties:
                          date:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                  time_aggregation:
                    type: string
                  time_rollups:
                    type: array
                    items:
                      type: string
                  time_windows:
                    type: array
                    items:
                      type: string
                  timezone:
                    type: string
      description: >
        <!-- theme: danger -->

        > ### This API is deprecated and will be removed soon

        >

        > The new API docs can be found here:
        https://apidocs.mediamath.com/docs/reporting-api-v2


        Get App Transparency Meta
  /brain_feature_summary/meta:
    get:
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                type: object
                properties: {}
      summary: Brain Feature Summary report
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        ## The Brain Feature Summary report


        Sample usage: GET
        https://api.mediamath.com/reporting/v1/std/brain_feature_summary/meta?v1


        ### Background


        The Brain Feature Summary report provides transparency into how the
        Brain optimizes.  The Brain Feature Summary Report centralizes
        impression features, such as Exchange, Site, Creative Size or Day of
        Week, that have the largest predictive impact.  Features are a column of
        dataset used as an input to the model. For example; device_model,
        day_of_week or browser. Descriptions of Current Brain Features are
        available
        [here](https://apidocs.mediamath.com/byoa/custom-brain/available-features). 
        Feature values are not listed in the report. This report gives you
        transparency into the importance of each Brain Feature at the aggregated
        level.


        The information in this report is provided when a new Brain model is
        generated, but some days in the reporting period may be missing (which
        is normal). Depending on the training data, we may not always generate a
        new model so you may see gaps (not all days will generate the report).
        The report time rollups are updated daily, typically before 18:00 UTC.
        The data contained for the date in the report will be for the latest
        model picked up on that day and loaded into reporting.  Retention is on
        a rolling 30 days, with a date range therefore of up to 30 days.  T1
        continues to train Brain models just in case the campaign is set live
        again, maximizing your opportunity to take advantage of the Brain
        Optimization on spend. Once there is no more training data (after 23
        days of no activity) T1 will stop generating new models until spend
        recommences.


        The information included in the Brain Feature Summary report is not
        relevant in the following circumstances:

        * Campaigns powered by a Custom Brain

        * CPA/ROI strategies within a campaign using 3rd-party attribution

        * CPA strategies within a campaign with post-view attribution discounted
        below 100%


        ### How to run a Brain Feature Summary report via T1 instead of by API:

        1. Navigate to the Reports module

        2. Click on the Data Export tab

        3. Type the name of the report in the File Name field

        4. Select the Brain Feature Summary report from the Report Type
        drop-down list

        5. Select the date range you want your report to cover

        6. Select Agency, Advertiser and Campaign from the relevant drop-down
        lists

        7. Select your preferred Dimensions


        ### The Brain Feature Summary report itself

        This report exports multiple campaigns and Goal Types at once.


        ### Sample CSV view of a Brain Feature Summary report


        | | A | B | C | D | E | F | G | H | I |

        |---|---|---|---|---|---|---|---|---|---|---|

        | 1 | start_date | end_date | organization_id | advertiser_id |
        agency_id | campaign_id | model_goal | feature |

        | 2 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        category_id |

        | 3 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        id_vintage |

        | 4 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        week_part |

        | 5 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        exchange_viewability_rate |

        | 6 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        region_id |

        | 7 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        conn_speed |

        | 8 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        day_of_week |

        | 9 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        browser_version |

        | 10 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        site_id |

        | 11 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        exchange_id_cs_site_id |

        | 12 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        day_part |

        | 13 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        dma_id |

        | 14 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        deal_id |

        | 15 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        os_id |


        ### What's in the Brain Feature Summary report

        | Column | Example* | Description |

        |---|---|---|

        | Start Date | 8/31/2019 | Date when these values were being used in
        bidding. |

        | End Date | 8/31/2019 | Date when these values were being used in
        bidding. |

        | Organization ID | 100001 | |

        | Agency ID | 10002 |

        | Advertiser ID | 10003 |

        | Campaign ID | 111111 | MediaMath unique ID for campaign. |

        | Model Goal | CPA, ROI, CPC, etc. | The Goal Type that the model was
        trained for. Each Goal Type will have a different Brain model. |

        | Feature |isp_id, day_of_week, size, week_part, category_id | The
        Dimension used as input into the Brain Machine Learning model. For a
        full list, see
        [here](https://apidocs.mediamath.com/byoa/custom-brain/available-features).
        |

        | Position | 0, 1, 2, 3, 4, ..., 99 | For bottom_features, a Position of
        0 means it had the lowest "Mean".  For top_features, a Position of 0
        means it had the highest "Mean". |

        | Index | 2.1925095 | The index column gives you a comparative
        indication of the relative importance of features based on normalized
        attribution, at an aggregated level. While the values might not make
        much sense for a global understanding of the model, the index gives an
        indication of what the model sees as important features when its
        trained. The higher the Index number, the higher the importance. |


        *Note: Only 1 value will appear, not a comma-delimited list, although
        feature_value may be a pipe-delimited list)
      operationId: Generate-Brain-Feature-Summary-report
      tags:
        - Reports
  /brain_feature_value/meta:
    get:
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                type: object
                properties: {}
      summary: Brain Feature Value report
      operationId: Generate-Brain-Feature-Value-report
      tags:
        - Reports
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        ## Brain Feature Value Report


        Sample usage: GET
        https://api.mediamath.com/reporting/v1/std/brain_feature_value/meta?v1


        ### Background

        The Brain Feature Value report gives you transparency into the top 100
        and bottom 100 feature values (e.g. site A, creative 123, exchange 1)
        that impact predictions for each optimization Goal Type (for example,
        ROI, CPA, VCR).  This shows how each Brain Feature Value directly
        influences and informs impression prediction and pricing.  Descriptions
        of Current Brain Features themselves are available
        [here](https://apidocs.mediamath.com/byoa/custom-brain/available-features).
        When T1 generates a Brain, there can be 200K+ predictions for Feature
        Values. To make these predictions more accessible, T1 selects the top
        100 and bottom 100 Feature Values (which can vary daily) generated for
        that day for your viewing per optimization goal.


        The information in this report is provided when a new Brain model is
        generated, but some days in the reporting period may be missing (which
        is normal). Depending on the training data, we may not always generate a
        new model so you may see gaps (not all days will generate the report).
        The report time rollups are updated daily, typically before 18:00 UTC.
        The data contained for the date in the report will be for the latest
        model picked up on that day and loaded into reporting.  Retention is on
        a rolling 30 days, with a date range therefore of up to 30 days.  T1
        continues to train Brain models just in case the campaign is set live
        again, maximizing your opportunity to take advantage of the Brain
        Optimization on spend. Once there is no more training data (after 23
        days of no activity) T1 will stop generating new models until spend
        recommences.


        The information included in the Brain Feature Value report is not
        relevant in the following circumstances:

        * Campaigns powered by a Custom Brain (for more on Custom Brain see
        [here](https://apidocs.mediamath.com/byoa/custom-brain/about))

        * CPA/ROI strategies within a campaign using 3rd-party attribution

        * CPA strategies within a campaign with post-view attribution discounted
        below 100%


        ### How to run a Brain Feature Value report via T1 instead of by API:

        1. Navigate to the Reports module

        2. Click on the Data Export tab

        3. Type the name of the report in the File Name field

        4. Select the Brain Feature Value report from the Report Type drop-down
        list

        5. Select the date range you want your report to cover

        6. Select Agency, Advertiser and Campaign from the relevant drop-down
        lists

        7. Select your preferred Dimensions


        ### The Brain Feature Value report itself

        This report exports multiple campaigns and Goal Types at once.


        ### Sample CSV view of a Brain Feature Value report

        | | A | B | C | D | E | F | G | H | I |

        |---|---|---|---|---|---|---|---|---|---|---|

        | 1 | start_date | end_date | organization_id | advertiser_id |
        agency_id | campaign_id | model_goal | feature_report_type | feature |

        | 2 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        top_features |  conn_speed |

        | 3 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        top_features |  exchange_id |

        | 4 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        top_features |  dma_id |

        | 5 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        top_features |  fold_position |

        | 6 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        top_features |  size |

        | 7 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        top_features |  os |

        | 8 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        top_features |  site_id |

        | 9 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        bottom_features |  id_vintage |

        | 10 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        bottom_features |  region_id |

        | 11 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        bottom_features |  day_of_week |

        | 12 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        bottom_features |  size |

        | 13 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        bottom_features |  device_id |

        | 14 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        bottom_features |  channel_type |

        | 15 | 10/8/2019 | 10/8/2019 | 100001 | 10002 | 10003 | 111111 | cpa |
        bottom_features |  country_id |


        ### What's in the Brain Feature Value report


        | Column | Example* | Description |

        |---|---|---|

        | Start Date | 8/31/2019 | Date when these values were being used in
        bidding. |

        | End Date | 8/31/2019\t| Date when these values were being used in
        bidding. |

        | Organization ID | 100000 | |

        | Agency ID | 10001 | User-specified (Step 6, below). |

        | Advertiser ID | 20000 | User-specified (Step 6, below). |

        | Campaign ID | 30000 | MediaMath unique ID for campaign. User-specified
        (Step 6, below). |

        | Model Goal | CPA, ROI, CPC, etc | The Goal Type that the model was
        trained for. Each Goal Type will have a different Brain model. |

        | Feature Report Type | bottom_features or 

        top_feature | bottom_features: a feature value that was in the bottom
        100 (lowest \"Mean\").  top_features: a feature value that as in the top
        100 (highest \"Mean\") |

        | Position | 0, 1, 2, 3, 4, ..., 9 | For bottom_features, a Position of
        0 means it had the lowest \"Mean\".  For top_features, a Position of 0
        means it had the highest \"Mean\". |

        | Feature | isp_id, day_of_week, size | The Feature that the next
        column’s Feature Value belongs to, used as input into the Brain Machine
        Learning model. For a full Feature list, see
        [here](https://apidocs.mediamath.com/campaigns/byoa/custom-brain/available-features).
        |

        | Feature Value| Verizon, Tuesday, 728x90 | Readable name of the Feature
        Value. Some Feature Values display in the report as hashed or otherwise
        manipulated in a way that does not accurately map back to a
        human-readable name, fields including Site ID, Category ID, and Region
        ID. In Q1 2020 or later, we hope to change the hashing to return these
        back to human readable names but until then it is in the backlog. Please
        provide feedback if you would find this an important feature to support
        sooner. The pipe character 'I' indicating that hashing has been applied
        may occur when there is a large number of Feature Values in a given
        Feature.  For example; site_id: \"539409862I130821751I231186\" or
        isp_id: \"WindstreamITelefonica\" |

        | Is Numeric | Y, N | A few of the Features (data types used in the
        prediction) are numerical in nature and will have a different impact on
        the prediction depending on the actual number (Y = Yes, it is numeric; N
        = No, it isn't numeric). One example is \"id_vintage\" which represents
        how long we’ve had an ID for the particular user we’re trying to predict
        the Response Rate for. Longer time means better quality (as they don't
        clear cookies/cache etc.) and improves the odds of conversions. The
        \"id_vintage\" field simplifies the large time spectrum into 4 specific
        ranges. |

        | Index | 123.855316, -60.73726 | This is based on the Mean. The index
        column gives you a comparative indication of the relative importance of
        features based on normalized attribution. While the mean values might
        not make much sense for a global understanding of the model, the index
        gives an indication of what the model sees as important features when
        its trained. The higher the Index number, the higher the importance. |

        | Mean | 0.00000648, -0.00000308 | When we train a model, we run a
        sample of the available data through our proprietary machine learning
        algorithm. The mean shown in this report is the Mean Attribution of the
        feature across samples of attribution. While technical, it may interest
        Data Science users. For the layman, it describes the \"average\"
        contribution of that Feature Value to the Predicted Response Rate. |

        | Bid Impact | 1.27748963, 0.93687577 | The marginal multiplicative
        contribution (> 1.0 increases, > 1.0 decreases) of a feature value (e.g.
        a particular exchange or site or creative) to a Predicted Response Rate
        (norm_rr).  The bid_impact is helpful for understanding pricing impact
        on that feature value, and to calculate CPM. An oversimplification: the
        baseline score is also impacted by a calibration coefficient. ***normrr
        = [campaign baseline score] x [bid impact of feature value #1] x [bid
        impact of feature value #2] …* *CPM = normrr x [strategy’s goal value] x
        1,000*** T1 logs the predicted Action Rate of specific impressions in
        the Log Level Data Service under a field called “norm_rr”. Please speak
        to your MediaMath Account representative for more information about
        accessing this data. |


        *Note: Only 1 value will appear, not a comma-delimited list, although
        feature_value may be a pipe-delimited list)
  /by_hour:
    get:
      operationId: GET_by_hour
      summary: By Hour
      tags:
        - Reports
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Standard performance metrics broken out by standard dimensions,
        available in precise time windows - down to the hour - with the option
        to aggregate by hour or day.
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
  /by_hour/meta:
    get:
      operationId: GET_by_hour-meta
      summary: By Hour Meta
      tags:
        - Reports
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/full-report-description'
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Get By Hour Meta
  /day_part:
    get:
      operationId: GET_day_part
      summary: Day Part
      tags:
        - Reports
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Standard performance metrics broken out by time of day and day of week.
        Available in standard intervals.
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
  /day_part/meta:
    get:
      operationId: GET_day_part-meta
      summary: Day Part Meta
      tags:
        - Reports
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/full-report-description'
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Get Day Part Meta
  /deals:
    get:
      operationId: GET_deals
      summary: Deals
      tags:
        - Reports
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        See or query the Meta Endpoint for required fields and parameters.


        Background:


        The Deals endpoint contains metrics describing the path from a matched
        bid opportunity (biddable) to a delivered impression (win) for private
        marketplace deals. Metrics from this endpoint will allow traders to
        observe the health of one or more deals. This will allow traders to make
        a more informed decision about what deals would be an ideal supply
        source for a particular strategy before committing test budget to it.
        Additionally, these metrics will help traders troubleshoot strategies
        targeting PMPs by providing deal win/loss metrics in isolation rather
        than having them tied to a creative or strategy. This helps traders
        understand how a deal is affecting their ability to scale more quickly
        and accurately.


        Update Times:


        This endpoint refreshes at the top of every hour, adding 1 hour of data
        within every refresh, on a one hour delay. For example, data from 1:00 –
        1:59 AM will become available at roughly 3:00 AM.


        Authorization:


        The deals endpoint uses the Private Marketplace Exchange (PMP-E) api for
        authorization -
        https://mediamath-pmp.api-docs.io/v1/private-marketplace-exchange-pmp-e/deals.
        Through the /deals endpoint, users can only receive reporting on deals
        in which their user is permissioned to the owner entity of the deal. A
        user permissioned to the owner entity of a deal indicates that the user
        has both read and write access of the deal. 


        To check what deals your user has read and write access to within a
        particular organization, please make the following get request to the
        Private Marketplace Exchange API:

        https://api.mediamath.com/media/v1.0/deals?owner.organization_id=[organization_id]


        Required Access Fields


        API calls must filter by the combination of organization id and deal id.
        Calls can include only one organization id and one to many deal id's as
        long as all of the deals belong to the organization. For example:


        filter=organization_id%3D[organization_id]%26deal_id%3D[deal_id]%2C[deal_id]
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
  /deals/meta:
    get:
      operationId: GET_deals-meta
      summary: Deals Meta
      tags:
        - Reports
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                type: object
                properties:
                  Description:
                    type: string
                  Name:
                    type: string
                  Type:
                    type: string
                  URI_Data:
                    type: string
                  URI_Meta:
                    type: string
                  Version:
                    type: integer
                  currency:
                    type: string
                  data_retention:
                    type: string
                  default_metrics:
                    type: array
                    items:
                      type: string
                  structure:
                    type: object
                    properties:
                      dimensions:
                        type: object
                        properties:
                          deal_currency_code:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                          deal_end_date:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          deal_external_id:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                          deal_id:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          deal_name:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                          deal_price:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          deal_price_method:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                              values:
                                type: array
                                items:
                                  type: string
                          deal_price_type:
                            type: object
                            properties:
                              maxLength:
                                type: integer
                              name:
                                type: string
                              type:
                                type: string
                              values:
                                type: array
                                items:
                                  type: string
                          deal_start_date:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          exchange_id:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          organization_id:
                            type: object
                            properties:
                              access:
                                type: boolean
                              name:
                                type: string
                              type:
                                type: string
                      metrics:
                        type: object
                        properties:
                          bid_rate:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          biddables:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          bids:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          win_rate:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                          wins:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                      time_field:
                        type: object
                        properties:
                          date:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                  time_aggregation:
                    type: string
                  time_rollups:
                    type: array
                    items:
                      type: string
                  time_windows:
                    type: array
                    items:
                      type: string
                  timezone:
                    type: string
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Get Deals Meta
  /device_technology:
    get:
      operationId: GET_device_technology
      summary: Device Technology
      tags:
        - Reports
      description: >-
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Standard performance metrics broken out by technology dimensions
        including browser, operating system, and connection type.  Available in
        custom date ranges or intervals with the option to aggregate by day,
        week, or month.


        ## Versions


        The API allows you to determine the version of the Device Technology
        Report by presenting a query parameter of `?v1` or `?v2`.


        Starting October 3rd, 2017 `v2` reports will include:


        - Device Brand – eg: Apple, Amazon, and Google

        - Device Model – eg: iPhone, Kindle Fire, Pixel

        - Browser Version – eg: Google Chrome

        - OS Version – eg: Windows 10


        This insight will allow you to plan and assess performance based on
        device and browser, now inclusive of Mobile devices.  Please note this
        release does not include targeting for these fields.


        The `v2` reports will return data starting from September 2nd, 2017. New
        data will be added to the reports moving forward, accumulating to the
        full 90 days of data; the max number of days a user is currently able to
        pull technology report data for.


        * All existing saved/scheduled technology reports in Data Export will
        continue to pull data from the old reporting framework until November
        1st, 2017. However, these reports will no longer be editable, meaning
        you may only export or deactivate the reports in the interim.

        * Additionally, all currently saved/scheduled technology reports will be
        **automatically deactivated on November 1st, 2017.**

        * From November 1st, 2017 technology reports will pull data from the
        `v2` version of the reports by default.

        * From November 1st, 2017 technology reports that query the `v1` version
        will result in a 304

        * The export will also contain 31 days of data starting from September
        2nd, 2017 and accumulate to the full 90 days.



        ## Migration


        After November 1st, any requests to the `device_technology` endpoint
        that specify removed metrics *will fail with an 'invalid request'
        error*. It is strongly recommended that you compare the v1 and v2
        definitions of the device technology report /meta endpoint.


        ## Dimensions


        - Added `device_type`

        - Added `os_version`

        - Added `operating_system`

        - Added `inventory_type`

        - Added `device_model`

        - Added `device_make`

        - Added `browser_version`

        - Added `browser`


        - Removed `browser_id`

        - Removed `browser_name`

        - Removed `device_id`

        - Removed `device_name`

        - Removed `inventory_type_id`

        - Removed `inventory_type_name`

        - Removed `os_id`

        - Removed `os_name`



        ## Metrics


        - Added `viewability_rate_100_percent`

        - Added `viewability_rate`

        - Added `in_view`

        - Added `in_view_100_percent`

        - Added `in_view_15_seconds`

        - Added `in_view_15_seconds_rate`

        - Added `in_view_5_seconds`

        - Added `in_view_5_seconds_rate`

        - Added `measurability_rate`

        - Added `measurable`

        - Added `media_cost_vcpm`

        - Added `total_ad_cost_vcpm`

        - Added `total_spend_vcpm`


        ## Time Windows


        - Added `campaign_to_date`
      parameters:
        - name: v1
          in: query
          description: _
          schema:
            type: string
        - name: v2
          in: query
          description: _
          schema:
            type: string
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
  /device_technology/meta:
    get:
      operationId: GET_device_technology-meta
      summary: Device Technology Meta
      tags:
        - Reports
      description: >-
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        ## Versions


        The API allows you to determine the version of the Device Technology
        Report by presenting a query parameter of `?v1` or `?v2`.


        Starting October 3rd, 2017 `v2` reports will include:


        - Device Brand – eg: Apple, Amazon, and Google

        - Device Model – eg: iPhone, Kindle Fire, Pixel

        - Browser Version – eg: Google Chrome

        - OS Version – eg: Windows 10


        This insight will allow you to plan and assess performance based on
        device and browser, now inclusive of Mobile devices.  Please note this
        release does not include targeting for these fields.


        Initially, the `v2` reports will only contain 31 days of data starting
        from September 2nd, 2017. New data will be added to the reports moving
        forward, accumulating to the full 90 days of data; the max number of
        days a user is currently able to pull technology report data for.


        * All existing saved/scheduled technology reports in Data Export will
        continue to pull data from the old reporting framework until November
        1st, 2017. However, these reports will no longer be editable, meaning
        you may only export or deactivate the reports in the interim.

        * Additionally, all currently saved/scheduled technology reports will be
        **automatically deactivated on November 1st, 2017.**

        * From November 1st, 2017 technology reports will pull data from the
        `v2` version of the reports by default.

        * The export will also contain 31 days of data starting from September
        2nd, 2017 and accumulate to the full 90 days.
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/full-report-description'
  /geo:
    get:
      operationId: GET_geo
      summary: Geo
      tags:
        - Reports
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}
  /geo/meta:
    get:
      operationId: GET_geo-meta
      summary: Geo Meta
      tags:
        - Reports
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Standard performance metrics broken out by geographic dimensions
        including country, region, and metro area.  Available in standard
        intervals.
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/full-report-description'
  /performance:
    get:
      operationId: GET_performance
      summary: Performance
      tags:
        - Reports
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Standard performance metrics in campaign currency and broken out by our
        widest array of dimensions.  Available in custom date ranges or
        intervals with the option to aggregate by day, week, or month.
      parameters:
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
  /performance/meta:
    get:
      operationId: GET_performance-meta
      summary: Performance Meta
      tags:
        - Reports
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/full-report-description'
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Get Performance Meta
  /postal_code:
    get:
      operationId: GET_postal_code
      summary: Postal Code
      tags:
        - Reports
      description: >-
        <!-- theme: danger -->

        > ### This API is deprecated and will be removed soon

        >

        > The new API docs can be found here:
        https://apidocs.mediamath.com/docs/reporting-api-v2


        The Postal Code Report breaks out performance metrics by postal code.
        Use it to optimize and validate strategies that use postal code
        targeting. 


        # API Endpoints


        The Postal Code Report is available at:


        `$API_BASE/postal_code`


        # Important Fields


        ### Report-Specific Dimensions and Metrics


        `postal_code` - The postal code dimension corresponds to postal codes as
        they are uploaded into t1 for targeting. This includes a country code
        followed by the postal code, with no space or punctuation. For example,
        an impression served to a computer at MediaMath's Broadway office (US
        ZIP code 10018) would have "us10018" as its postal code.  If a postal
        code is unknown, it will still be shown with the country code: ex.
        "us-unknown".  If not, it will appear as simply "unknown".   


        NOTE: The postal code report only breaks out strategies by postal code
        if those strategies are targeting or anti-targeting postal codes.  If a
        strategy stops or starts targeting postal codes, you may see unexpected
        postal code values in the report for the day that the change was made. 
        This is because the bidder reacts to your targeting changes immediately,
        but our report only takes them into account when it refreshes.  In order
        to prevent this, it is recommend that users create a dedicated strategy
        for postal code targeting.


        ### Date Range


        The Postal Code Report is available by day for a rolling 30 days.


        # Updates


        Data is updated three times daily.
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
  /postal_code/meta:
    get:
      operationId: GET_postal_code-meta
      summary: Postal Code Meta
      tags:
        - Reports
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/full-report-description'
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Get Postal Code Meta
  /reach_frequency:
    get:
      operationId: GET_reach_frequency
      summary: Reach Frequency
      tags:
        - Reports
      description: >-
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        The Reach and Frequency report measures the number of unique users your
        ads are reaching and the frequency with which your users see those ads.
        Use it to monitor your reach, or to understand how the number of ads a
        customer sees influences their click and conversion behavior.


        # API Endpoints


        The Reach and Frequency Report is available at:


        `$API_BASE/reach_frequency`


        # Important Fields


        ### Report-Specific Fields


        `frequency` - shows the average number of times a unique user saw media
        from the given strategy or campaign


        `frequency_bin` - provides bins for ranges of frequency values. It’s
        useful for creating a histogram to show the distribution of frequency,
        or for analyzing how frequency correlates to performance metrics.


        `uniques` - measures the number of unique users who viewed an impression
        from the given campaign or strategy. Uniques are identified using
        cookies, so this number could be slightly overstated if your audience
        uses many different devices or clears their cookies often.


        NOTE: Uniques and frequencies are only counted for campaigns and
        strategies. Including advertiser or organization may be useful as
        metadata, but if you do not include campaign or strategy, uniques will
        be aggregated without de-duping and your data will be inaccurate. For
        this reason, you should always include either the campaign or strategy
        dimensions.


        ### Time Fields


        `reach_frequency` is available as an interval report. It supports four
        time windows: yesterday, `last_7_days`, `last_14_days`, `last_30_days`,
        `last_60_days` and `last_90_days`. The only `time_aggregation` available
        is “all”.


        # Updates


        Data is updated daily. Check the Last-Modified date in the header for
        more specific timing.
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
  /reach_frequency/meta:
    get:
      operationId: GET_reach_frequency-meta
      summary: Reach Frequency Meta
      tags:
        - Reports
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/full-report-description'
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Get Reach Frequency Meta
  /site_transparency:
    get:
      operationId: GET_site_transparency
      summary: Site Transparency
      tags:
        - Reports
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Get Site Transparency
  /site_transparency/meta:
    get:
      operationId: GET_site_transparency-meta
      summary: Site Transparency Meta
      tags:
        - Reports
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Standard performance metrics broken out by the domain of the inventory. 
        Available in standard intervals.
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/full-report-description'
  /watermark:
    get:
      operationId: GET_watermark
      summary: Watermark
      tags:
        - Reports
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Watermark metrics show how many impressions and how much spend went
        towards the brain's learning activities.  Viewable by campaign and
        strategy dimensions and available by day.
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
  /watermark/meta:
    get:
      operationId: GET_watermark-meta
      summary: Watermark Meta
      tags:
        - Reports
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/full-report-description'
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Get Watermark Meta
  /win_loss:
    get:
      operationId: GET_win_loss
      summary: Win Loss
      tags:
        - Reports
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
           The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
         {% /admonition %}

         Metrics describe the auction before a win or even a bid has taken place.  Broken out by strategy, exchange, and deal dimensions and available by hour.
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
  /win_loss/meta:
    get:
      operationId: GET_win_loss-meta
      summary: Win Loss Meta
      tags:
        - Reports
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Metrics describe the auction before a win or even a bid has taken
        place.  Broken out by strategy, exchange, and deal dimensions and
        available by hour.
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/full-report-description'
  /win_loss_creative:
    get:
      operationId: GET_win_loss_creative
      summary: Win/Loss by Creative
      tags:
        - Reports
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
           The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
         {% /admonition %}

         Metrics describe the auction before a win has taken place. Broken out by creative dimensions and available by hour.
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_dimensions'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_metrics'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_filter'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_having'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_rollup'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_time_window'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_start_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_end_date'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_order'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_limit'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_page_offset'
        - $ref: '#/components/parameters/trait_requestsCustomTimeWindow_precision'
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_Accept-Encoding_
        - $ref: >-
            #/components/parameters/trait_requestsCustomTimeWindow_If-Modified-Since
      responses:
        '200':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_200'
        '304':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_304'
        '400':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_400'
        '401':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_401'
        '403':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_403'
        '404':
          $ref: '#/components/responses/trait_requestsCustomTimeWindow_404'
  /win_loss_creative/meta:
    get:
      operationId: GET_win_loss_creative-meta
      summary: Win/Loss by Creative Meta
      tags:
        - Reports
      description: >
        {% admonition type="danger" name="This API is deprecated and will be
        removed in July 2026" %}
          The new API docs can be found here: [https://apidocs.mediamath.com/apis/reporting-api](https://apidocs.mediamath.com/apis/reporting-api)
        {% /admonition %}


        Metrics describe the auction before a win has taken place. Broken out by
        creative dimensions and available by hour.
      parameters:
        - $ref: '#/components/parameters/trait_cookieAuth_Cookie'
      responses:
        '200':
          description: ''
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/full-report-description'
tags:
  - name: Data Retrieval
    description: _
  - name: Metadata
    description: _
  - name: Reports
    description: _
servers:
  - url: https://api.mediamath.com/reporting/v1/std
components:
  parameters:
    trait_cookieAuth_Cookie:
      name: Cookie
      description: _
      in: header
      required: true
      schema:
        type: string
        default: adama_session=<<sessionid>>
    trait_jsonResponse_Accept:
      name: Accept
      description: _
      in: header
      required: false
      schema:
        type: string
        default: application/vnd.mediamath.v1+json
    trait_limit_page_limit:
      name: page_limit
      description: _
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
    trait_limit_page_offset:
      name: page_offset
      in: query
      description: Index of the first element in the collection to retrieve
      required: false
      schema:
        type: integer
    trait_oAuth2Jwt_Authorization:
      name: Authorization
      in: header
      description: >-
        The OAuth2 token. See
        https://mediamath-auth.api-docs.io/v2/oauth2/oauth2-api-access for more
        information.
      required: true
      schema:
        type: string
        pattern: Bearer .*
    trait_querying_q:
      name: q
      description: _
      in: query
      required: false
      schema:
        type: string
        items:
          type: string
    trait_returnAdditionalEntityProperties_full:
      name: full
      in: query
      description: >-
        To include all properties for all entities returned by the API call, use
        `full=*:`
      required: false
      schema:
        type: string
        items:
          type: string
        default: ''
    trait_returnAdditionalEntityProperties_with:
      name: with
      description: _
      in: query
      required: false
      schema:
        type: string
        items:
          type: string
    trait_sorting_sort_by:
      name: sort_by
      in: query
      description: name
      required: false
      schema:
        type: string
        items:
          type: string
    trait_requestsCustomTimeWindow_dimensions:
      name: dimensions
      in: query
      description: >-
        Selects the dimension fields to use in grouping rows.


        This should be a comma-separated list of dimension field names.


        The position of the fields in the output is not guaranteed to match the
        parameter value.  Always use the header line from the response body to
        identify the position of each column in the output.
      required: true
      schema:
        type: string
    trait_requestsCustomTimeWindow_metrics:
      name: metrics
      in: query
      description: >-
        Controls the selection of metric fields.


        This should be a comma-separated list of metric field names.


        If not specified, this will default to the metric fields specified by
        the `default_metrics` property of the
        <https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta>.


        The position of the fields in the output is not guaranteed to match the
        parameter value.  Always use the header line from the response body to
        identify the position of each column in the output.
      required: false
      schema:
        type: string
    trait_requestsCustomTimeWindow_filter:
      name: filter
      in: query
      description: >-
        Controls filtering against dimension fields.  The filtering is performed
        before row grouping.  See the Predicate Parameters section of
        <https://apidocs.mediamath.com/apis/reporting-api-v1/data-retrieval/get_report>
        for more information about interpretation and accepted formats.
      required: true
      schema:
        type: string
    trait_requestsCustomTimeWindow_having:
      name: having
      in: query
      description: >-
        Controls filtering against metric and dimension fields.  The filtering
        is performed after row grouping and metric calculation.  See the
        Predicate Parameters section of
        <https://apidocs.mediamath.com/apis/reporting-api-v1/data-retrieval/get_report>
        for more information about interpretation and accepted formats.
      required: false
      schema:
        type: string
    trait_requestsCustomTimeWindow_time_rollup:
      name: time_rollup
      in: query
      description: >-
        The allowed values are specified by the time_rollups report meta
        property.  See the Time Field section of
        <https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta>
        for more information.
      required: true
      schema:
        type: string
    trait_requestsCustomTimeWindow_time_window:
      name: time_window
      in: query
      description: >-
        Controls filtering against the time field for the report.  See the Time
        Field section of
        <https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta>
        for more information.
      required: true
      schema:
        type: string
    trait_requestsCustomTimeWindow_start_date:
      name: start_date
      in: query
      description: >-
        Controls filtering against the time field for the report.  See the Time
        Field section of
        <https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta>
        for more information.
      required: true
      schema:
        type: string
    trait_requestsCustomTimeWindow_end_date:
      name: end_date
      in: query
      description: >-
        Controls filtering against the time field for the report.  See the Time
        Field section of
        <https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta>
        for more information.
      required: false
      schema:
        type: string
        default: yesterday
    trait_requestsCustomTimeWindow_order:
      name: order
      in: query
      description: >-
        Controls the sorting of the groups.


        This should be a comma-separated list of field names.  Each field name
        may optionally be prefixed with a minus sign to indicate descending
        order.  Otherwise, ascending order is assumed.


        The first field has the most significance in sorting.
      required: false
      schema:
        type: string
    trait_requestsCustomTimeWindow_page_limit:
      name: page_limit
      in: query
      description: |-
        Controls the maximum number of rows of data.

        This parameter is required, if page_offset is one or greater.
      required: false
      schema:
        type: integer
        minimum: 1
        default: 100
    trait_requestsCustomTimeWindow_page_offset:
      name: page_offset
      in: query
      description: Controls how many pages to skip.
      required: false
      schema:
        type: integer
        minimum: 0
    trait_requestsCustomTimeWindow_precision:
      name: precision
      in: query
      description: >-
        Controls how many digits to the right of the decimal places to display
        for float types.
      required: false
      schema:
        type: integer
        minimum: 0
        maximum: 8
        default: 8
    trait_requestsCustomTimeWindow_Accept-Encoding_:
      name: 'Accept-Encoding:'
      in: header
      description: >-
        If the client supports the compression methods also supported by the
        server (currently `gzip` and `deflate`), the response data set
        (`text`\/`csv`) will be returned in a compressed format. The metadata
        and error responses will not be compressed.


        In order to receive the data in compressed format, the client must use
        the HTTP request header `Accept-Encoding`, and enumerate the preferred
        compression methods (see [RFC
        2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html)). If the
        header `Accept-Encoding` is not present in the request, or if it
        contains only compression methods not supported by the system, the data
        will be returned in an uncompressed format.

            ###  request 
            Accept-Encoding: gzip,deflate   

            ###  response  
            Content-Encoding: gzip 
            Content-Type: text/csv; charset=UTF-8 
      schema:
        type: string
        enum:
          - gzip,deflate
    trait_requestsCustomTimeWindow_If-Modified-Since:
      name: If-Modified-Since
      in: header
      description: >-
        If the data has not changed, the server responds with a 304 Not Modified
        status code and an empty response body.


        If the same request was issued and the data had been updated since the
        specified time, the server responds with the data requested and a new
        Last-Modified header.
      schema:
        type: string
        format: date-time
  responses:
    trait_notFoundAble_404:
      description: ''
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/error-response'
    trait_requestsCustomTimeWindow_200:
      description: ''
    trait_requestsCustomTimeWindow_304:
      description: ''
    trait_requestsCustomTimeWindow_400:
      description: ''
    trait_requestsCustomTimeWindow_401:
      description: ''
    trait_requestsCustomTimeWindow_403:
      description: ''
    trait_requestsCustomTimeWindow_404:
      description: ''
  securitySchemes:
    API_Key_-_1:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.mediamath.com/oauth/token
          scopes: {}
  schemas:
    error-response:
      title: Error Response
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/errors'
        meta:
          type: object
      x-stoplight:
        id: gd90hz50o1go6
    errors:
      title: Errors
      type: array
      items:
        type: object
        properties:
          code:
            type: string
          message:
            type: string
          field:
            type: string
        required:
          - code
          - message
      x-stoplight:
        id: 84qlj054uhiwa
    brief-report-description:
      title: Brief Report Description
      type: object
      properties:
        Name:
          type: string
          description: >-
            This is the human-readable name of the report.  It is not recognized
            by any API input.
        Version:
          type: integer
          description: >-
            This is the version of the report.  See the
            <https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta>
            section for more details.
        Description:
          type: string
        URI_Data:
          type: string
          format: uri
          description: >-
            This is the URI for the report's
            <https://apidocs.mediamath.com/apis/reporting-api-v1/data-retrieval/get_report>
            endpoint.
        URI_Meta:
          type: string
          format: uri
          description: >-
            This is the URI for the report's
            <https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta>.
        Transition:
          type: object
          description: >-
            Reports may change over time.  This object will be present if the
            report will undergo a breaking change.  See the
            <https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta>
            section for more details.
          properties:
            replaced_by:
              type: string
              format: uri
              description: >-
                The URL where the metadata for the next version of the report
                may be found.
            transition_date:
              type: string
              format: date-time
              description: >-
                After this GMT time the current version of the report will no
                longer be available.
            next_version:
              type: integer
              description: The version replacing the current version of the report.
          required:
            - replaced_by
            - transition_date
            - next_version
        Deprecation:
          type: object
          description: >-
            Reports may be deprecated all together, or superseded by another
            report.  This object will be present if the report is scheduled for
            deprecation.   See the
            <https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta>
            section for more details.
          properties:
            superseded_by:
              type: string
              format: uri
              description: Optionally provides the metadata URI for the superseding report.
            deprecation_date:
              type: string
              format: date-time
              description: >-
                The GMT time when the report will no longer be available.  When
                a report is past its `deprecation_date` it will no longer appear
                in the
                <https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta>. 
                All endpoints having to do specifically with that report will
                return a 410 GONE response.
          required:
            - deprecation_date
      required:
        - Name
        - Version
        - URI_Data
        - URI_Meta
      x-stoplight:
        id: k6iyargwoudhr
    full-report-description:
      title: Full Report Description
      allOf:
        - $ref: '#/components/schemas/brief-report-description'
        - type: object
          properties:
            Type:
              type: string
            currency:
              type: string
              description: >-
                Provides information about the currency of the `metrics` fields
                typed as "money".


                When set to "campaign currency", the currency varies from record
                to record.  To determine the currency for a particular record,
                the campaign_currency_code `dimensions` field should be
                requested, if available for the report.


                Any other value should be taken to be the currency for all
                records of the report.
            data_retention:
              type: string
              description: >-
                Indicates how far back data is available.  This can be a date,
                datetime, or time window as specified by the "time_window" and
                "Special Time Windows" sections of
                <https://apidocs.mediamath.com/apis/reporting-api-v1/section/fields>. 
                This property should be used very loosely.  It may not be
                accurate.  It is meant to give a general idea.
            default_metrics:
              type: array
              description: >-
                This is the list of metrics that will be returned if the
                `metrics` parameter is not specified in a call to the
                <https://apidocs.mediamath.com/apis/reporting-api-v1/data-retrieval/get_report>.
              items:
                type: string
            structure:
              type: object
              required:
                - time_field
                - dimensions
                - metrics
              properties:
                time_field:
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/field-description'
                  description: >-
                    Mapping of field names seen in
                    <https://apidocs.mediamath.com/apis/reporting-api-v1/section/fields>
                dimensions:
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/field-description'
                  description: >-
                    Mapping of field names seen in
                    <https://apidocs.mediamath.com/apis/reporting-api-v1/section/fields>
                metrics:
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/field-description'
                  description: >-
                    Mapping of field names seen in
                    <https://apidocs.mediamath.com/apis/reporting-api-v1/section/fields>
            time_aggregation:
              type: string
              description: >-
                This property indicates the finest granularity of the
                `time_field`.  For reports with a `time_field` of the `datetime`
                type, this will be "by_hour", "by_day", etc.  When the type is
                `interval`, this will be "various".
            time_rollups:
              type: array
              description: >-
                This property indicates the available levels of granularity for
                the `time_field`.  It lists the valid values of the
                `time_rollup` parameter used for the
                <https://apidocs.mediamath.com/apis/reporting-api-v1/data-retrieval/get_report>
                endpoint.  For reports with a `time_field` of the `datetime`
                type, this tends to be a combination of "by_hour", "by_day",
                "by_week", "by_month", "all", etc.  When the type is `interval`,
                this will only include "all".
              items:
                type: string
            time_windows:
              type: array
              description: >-
                Lists the acceptable formats for the `time_window` parameter
                used by the
                <https://apidocs.mediamath.com/apis/reporting-api-v1/data-retrieval/get_report>. 
                Some values may be used as is, others may need to be modified. 
                For details see the time_window section of 
                <https://apidocs.mediamath.com/apis/reporting-api-v1/section/fields>.
              items:
                type: string
            timezone:
              type: string
              description: >-
                Provides information about the timezone of the `time_field` for
                the report.


                When set to "campaign timezone", the timezone varies from record
                to record.  To determine the currency for a particular record,
                the campaign_timezone `dimensions` field should be requested, if
                available for the report.


                Any other value should be taken to be the timezone for all
                records of the report.
          required:
            - default_metrics
            - structure
            - time_rollups
            - time_windows
      x-stoplight:
        id: 8plabb85jgk95
    field-description:
      title: Field Description
      type: object
      properties:
        name:
          type: string
          description: This is the human-readable name of the field.
        type:
          type: string
          enum:
            - float
            - money
            - percent
            - ratio
            - integer
            - count
            - rank
            - datetime
            - string
            - interval
            - id
            - bool
            - boolean
        access:
          type: boolean
          description: >-
            This property is applicable to dimension fields only.  Every request
            must have at least one filter or having predicate against a field
            with this property set.
        description:
          type: string
        maxLength:
          type: number
          description: >-
            This property describes the allowable length for string-typed
            fields.
        values:
          type: array
          description: >-
            Enumerates the possible values that this field may represent.  When
            using an equality predicate, all predicate values must match one of
            the enumerated entries.
          items:
            type: string
      required:
        - name
        - type
      x-stoplight:
        id: ay5bipqhvuzoi
    reports-list:
      title: Reports List
      type: object
      properties:
        reports:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/brief-report-description'
          description: >-
            This is a mapping of report names to
            <https://apidocs.mediamath.com/apis/reporting-api-v1/metadata/get_report-meta>.
      x-stoplight:
        id: dnol54v50tvke
