Create a request for a Marketing Mix Modeling (MMM) report
Changed onThis 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.
Request
- Base URLhttps://api.pinterest.com/v5
- AuthOAuth 2Authorization codehttps://www.pinterest.com/oauth/Token URLhttps://api.pinterest.com/v5/oauth/tokenScopesads:read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Request body
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.
Example response
{
"report_status": "FINISHED",
"status": "success"
}Changes
- breaking
added to the
request propertyallOflist - breaking
added to the
request propertyallOflist - breaking
removed the enum value
AD_GROUP_TARGETINGof the request property - breaking
removed the enum value
CAMPAIGN_TARGETINGof the request property - breaking
removed the enum value
DAYof the request property - breaking
removed the enum value
WEEKof the request property - breaking
the
request property type changed fromstringto no type - breaking
the
request property type changed fromstringto no type - warning
removed
subschema #1from the request bodyallOflist - 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_DOLLARenum value to the request property/ - info
added the new
ADVERTISER_PAID_ECPC_IN_DOLLARenum value to the request property/ - info
added the new
ADVERTISER_PAID_ECPM_IN_DOLLARenum value to the request property/ - info
added the new
ADVERTISER_PAID_SPEND_IN_DOLLARenum value to the request property/ - info
added the new
AUDIENCE_INCLUDEenum value to the request property/ - info
added the new
CAMPAIGN_OBJECTIVE_TYPEenum value to the request property/ - info
added the new
PINNER_LIST_NAMEenum value to the request property/ - info
added the new
PLACEMENTenum 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
- breaking
- info
endpoint added
- info