ad_accounts

Create a request for a Marketing Mix Modeling (MMM) report

Changed on
This creates an asynchronous mmm report based on the given request.
It returns a token that you can use to download the report when it is
ready. NOTE: An additional limit of 5 queries per minute per advertiser
applies to this endpoint while it's in beta release.
For the ADVERTISER_PAID_SPEND_IN_DOLLAR,
ADVERTISER_PAID_ECPC_IN_DOLLAR, and ADVERTISER_PAID_ECPM_IN_DOLLAR
columns: if you receive bonus media, this value still includes that spend, and it will
need to be removed manually with support from your Pinterest account team for a
fully netted value. Over time, we'll also subtract bonus media and other incentives as
data becomes available. Production and other non-media fees are excluded.
post/ad_accounts/{ad_account_id}/mmm_reports

Request

Path parameters

ad_account_idstring required

Request body

advertiser_idsstring[]

Advertiser IDs for multi-advertiser report

columnsMMMReportingColumn[] required

Metric and entity columns

countriesTargetingAdvertiserCountry[]

A List of countries for filtering

custom_column_idsstring[]

List of custom column IDs

end_datestring required

Metric report end date (UTC). Format: YYYY-MM-DD

granularity'DAY' | 'WEEK' required
level'CAMPAIGN_TARGETING' | 'AD_GROUP_TARGETING' required
report_namestring required

Name of the Marketing Mix Modeling (MMM) report

start_datestring required

Metric report start date (UTC). Format: YYYY-MM-DD

targeting_typesMMMReportingTargetingType[] required

List of targeting types

Example request

{
  "columns": [
    "SPEND_IN_DOLLAR"
  ],
  "countries": [
    "US"
  ],
  "end_date": "2020-12-20",
  "start_date": "2020-12-20",
  "targeting_types": [
    "GENDER"
  ]
}

Response

The request has succeeded.

messagestring
report_status'DOES_NOT_EXIST' | 'FINISHED' | 'IN_PROGRESS' | 'EXPIRED' | 'FAILED' | 'CANCELLED'

Possible status for a bulk reporting job

sizenumber
statusstring
tokenstring
urlstring

Example response

{
  "report_status": "FINISHED",
  "status": "success"
}

Changes

    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      removed the enum value AD_GROUP_TARGETING of the request property

    • breaking

      removed the enum value CAMPAIGN_TARGETING of the request property

    • breaking

      removed the enum value DAY of the request property

    • breaking

      removed the enum value WEEK of the request property

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • warning

      removed subschema #1 from the request body allOf list

    • warning

      changed the pattern of the request property from ^(\d{4})-(\d{2})-(\d{2})$ to ^\d{4}-\d{2}-\d{2}$

    • warning

      changed the pattern of the request property from ^(\d{4})-(\d{2})-(\d{2})$ to ^\d{4}-\d{2}-\d{2}$

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new ADS_CREDIT_SPEND_IN_DOLLAR enum value to the request property /

    • info

      added the new ADVERTISER_PAID_ECPC_IN_DOLLAR enum value to the request property /

    • info

      added the new ADVERTISER_PAID_ECPM_IN_DOLLAR enum value to the request property /

    • info

      added the new ADVERTISER_PAID_SPEND_IN_DOLLAR enum value to the request property /

    • info

      added the new AUDIENCE_INCLUDE enum value to the request property /

    • info

      added the new CAMPAIGN_OBJECTIVE_TYPE enum value to the request property /

    • info

      added the new PINNER_LIST_NAME enum value to the request property /

    • info

      added the new PLACEMENT enum value to the request property /

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the success response with the status

    • info

      endpoint added