openapi: 3.1.0 info: title: MikMak Insights API description: ' ## Introduction An API for querying reports and report-related data. A set of API credentials is tied to one account; each request to the API will return data specific to that account.' version: 1.0.0 components: securitySchemes: authorization: type: http scheme: bearer description: 'Enter your API key as a normal token. This will send a header that looks like "Authorization: Bearer {your_api_key}"' x-api-key: type: apiKey in: header name: x-api-key description: 'Enter your API key as a normal token. This will send a header that looks like "x-api-key: {your_api_key}"' schemas: AdvancedFilterDimension: properties: name: type: string title: Name displayName: type: string title: Displayname operators: items: $ref: '#/components/schemas/AdvancedFilterOperator' type: array title: Operators type: object required: - name - displayName - operators title: AdvancedFilterDimension description: Dimension metadata for the advanced filter component (name, displayName, and operators). AdvancedFilterMetric: properties: name: type: string title: Name displayName: type: string title: Displayname operators: items: $ref: '#/components/schemas/AdvancedFilterOperator' type: array title: Operators dataType: $ref: '#/components/schemas/MetricDataType' description: Data type for formatting/validation (e.g. integer, percentage, currency). Actual currency code comes from the request. type: object required: - name - displayName - operators - dataType title: AdvancedFilterMetric description: Metric metadata for the advanced filter component (name, displayName, operators, dataType). AdvancedFilterOperator: properties: code: type: string title: Code label: type: string title: Label type: object required: - code - label title: AdvancedFilterOperator description: 'Operator option: code is the JSON key on custom_report filter bodies; label is UI copy.' ClearCacheResponse: properties: success: type: boolean title: Success message: type: string title: Message keys_cleared: type: integer title: Keys Cleared prefix: anyOf: - type: string - type: 'null' title: Prefix type: object required: - success - message - keys_cleared title: ClearCacheResponse description: Response model for cache clearing endpoint. CodedStrFilters: additionalProperties: false description: Equality-only string filters for coded / non-UTF8 dimensions (no contains). properties: includes: description: Include rows where value is in this list (IN). items: type: string title: Includes type: array excludes: description: Exclude rows where value is in this list (NOT IN). items: type: string title: Excludes type: array title: CodedStrFilters type: object Column: properties: key: anyOf: - $ref: '#/components/schemas/Dimensions' - $ref: '#/components/schemas/Metrics' title: Key type: $ref: '#/components/schemas/ColumnType' displayName: type: string title: Displayname description: Human-readable column title. When the report date range starts before a metric or dimension availability date (see startDate on custom_report_fields), the API appends a parenthetical suffix with Unicode U+26A0, either 'Metric start date' or 'Dimension start date', and an ISO YYYY-MM-DD date. tooltip: anyOf: - type: string - type: 'null' title: Tooltip type: object required: - key - type - displayName title: Column ColumnType: type: string enum: - count - date - str - percent - money - int - float - distinct title: ColumnType description: 'UI-facing column rendering hint for report cells. Members: - count: Integer count (rendered as a plain number). - date: Calendar date. - str: Free-form string. - percent: Percentage rate (rendered with % suffix). - money: Monetary value (rendered with the report''s currency). - int: Integer value (non-count, e.g., identifiers). - float: Floating-point number. - distinct: Distinct count / cardinality.' CommerceType: description: 'Commerce touchpoint type (the ``commerceType`` dimension). Members: - ST: Brand.com (direct brand website touchpoint). - LP: Landing Page. - DP: Ad Unit (Display). - VD: Ad Unit (Video). - IP: Media. - DL: Retailer Direct (Retail Media). - AP: In-App. - API: API (programmatic integration).' enum: - ST - LP - DP - VD - IP - DL - AP - API title: CommerceType type: string CommerceTypeFilters: additionalProperties: false description: Filter by Commerce touchpoint type; see :class:`CommerceType` for allowed codes. properties: includes: description: Include rows where commerceType matches any of these touchpoint codes (IN). See CommerceType for allowed values. items: $ref: '#/components/schemas/CommerceType' title: Includes type: array excludes: description: Exclude rows where commerceType matches any of these touchpoint codes (NOT IN). See CommerceType for allowed values. items: $ref: '#/components/schemas/CommerceType' title: Excludes type: array title: CommerceTypeFilters type: object CountryFilters: additionalProperties: false description: 'Filter by ISO 3166-1 alpha-2 country codes (e.g. ``US``, ``FR``). Full country names (e.g. ``France``) are rejected; use the 2-character code.' properties: includes: description: Include rows where the country dimension matches any of these 2-character ISO 3166-1 alpha-2 codes (e.g. 'FR', 'US'). Do not use full country names like 'France'. items: pattern: ^\w{2}$ type: string title: Includes type: array excludes: description: Exclude rows where the country dimension matches any of these 2-character ISO 3166-1 alpha-2 codes (e.g. 'FR', 'US'). Do not use full country names like 'France'. items: pattern: ^\w{2}$ type: string title: Excludes type: array title: CountryFilters type: object CurrencyFilters: additionalProperties: false description: Filter by ISO 4217 currency codes (e.g. ``USD``, ``EUR``). properties: includes: description: Include rows where the currency dimension matches any of these ISO 4217 codes (IN). items: maxLength: 3 minLength: 3 pattern: ^\w{3}$ type: string title: Includes type: array excludes: description: Exclude rows where the currency dimension matches any of these ISO 4217 codes (NOT IN). items: maxLength: 3 minLength: 3 pattern: ^\w{3}$ type: string title: Excludes type: array title: CurrencyFilters type: object CustomReportAdvancedFiltersRequestBody: properties: accountId: type: string title: Accountid description: Account ID; if not provided, taken from the token. metrics: items: type: string type: array title: Metrics description: Metric identifiers for which to return filter metadata. dimensions: items: type: string type: array title: Dimensions description: Dimension identifiers used for exclusion rules. currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL maxLength: 3 minLength: 3 title: Currency description: Currency for monetary metrics. filters: items: type: string type: array title: Filters description: Optional filter dimension names; used for exclusion rules. Not required. default: [] subaccountIds: anyOf: - items: type: string type: array - type: 'null' title: Subaccountids description: Optional subaccount IDs for Aura metric eligibility. type: object required: - accountId - metrics - dimensions - currency title: CustomReportAdvancedFiltersRequestBody description: Request body for advanced filter component init. No filters section required. CustomReportFacetsRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: properties: alternateProductName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Alternate Product Name filter. Alternate product name from the Catalog. brandEntity: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Reporting Brand filter. The Brand Entity associated with MikMak metrics. commerceType: anyOf: - $ref: '#/components/schemas/CommerceTypeFilters' - type: 'null' description: Commerce Type filter. Type of MikMak Commerce Experience (Brand.com, Media, etc.) country: anyOf: - $ref: '#/components/schemas/CountryFilters' - type: 'null' description: Country filter. Geographic country associated with the Commerce Experience. deviceType: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Device Type filter. The category of the visitor's hardware (Desktop, Mobile, Tablet, or Others), detected via the user agent associated with the metric. domainUrl: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Domain URL filter. The web domain associated with the metric. experience: anyOf: - $ref: '#/components/schemas/ObjectIdFilters' - type: 'null' description: Commerce Experience filter. Name of the Commerce Experience. isBundle: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Bundle filter. Whether the metric is tied to a bundle of products. modelName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Model Name filter. Model name from the Catalog. mpn: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: MPN filter. Manufacturer Part Number of the catalog product in the Commerce Experience. pageUrl: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Page URL filter. The web page associated with the metric. productBrandName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Brand Name filter. Brand of the catalog product in the Commerce Experience. productCategoryName: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Product Category Name filter. Category of the catalog product in the Commerce Experience. productCustomCategory: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Category filter. Custom category of the catalog product in the Commerce Experience. productCustomSubcategory1: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 1 filter. Custom subcategory (level 1) of the catalog product in the Commerce Experience. productCustomSubcategory2: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 2 filter. Custom subcategory (level 2) of the catalog product in the Commerce Experience. productCustomSubcategory3: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 3 filter. Custom subcategory (level 3) of the catalog product in the Commerce Experience. productCustomSubcategory4: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 4 filter. Custom subcategory (level 4) of the catalog product in the Commerce Experience. productLine: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Product Line filter. Line of the catalog product in the Commerce Experience. productName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Name filter. Name of the catalog product in the Commerce Experience. productRange: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Product Range filter. Range of the catalog product in the Commerce Experience. retailer: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Retailer Name filter. Name of the online or offline retailer associated with a click or transaction. shopperCity: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Shopper City filter. The city, town, or municipality where the shopper was located during the session. shopperCountry: anyOf: - $ref: '#/components/schemas/CountryFilters' - type: 'null' description: Shopper Country filter. The country where the shopper was located during the session. shopperRegion: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Shopper Region filter. The primary administrative division (e.g., State, Province, or Region, dependent on the country) where the shopper was located during the session. shopperZipCode: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Shopper Zip Code filter. The local postal code or ZIP code associated with the shopper's location. standardMedium: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Standard Medium filter. The categorized version of the utm_medium parameter, mapping various raw values into a standardized set of marketing mediums. standardSource: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Standard Source filter. The categorized version of the utm_source parameter, mapping various raw values into a standardized set of traffic sources. subaccountId: anyOf: - $ref: '#/components/schemas/ObjectIdFilters' - type: 'null' description: Subaccount filter. MikMak subaccount that contains the Experience associated with the metric. utmAdId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Ad ID (utm) filter. Value of the utm_adid parameter, if present, in the URL associated with the metric. utmAdvertiserId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Advertiser ID (utm) filter. Value of the utm_advertiserid parameter, if present, in the URL associated with the metric. utmBu: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Business Unit (utm) filter. Value of the utm_bu parameter, if present, in the URL associated with the metric. utmCampaign: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Campaign (utm) filter. Value of the utm_campaign parameter, if present, in the URL associated with the metric. utmClicktype: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Click Type (utm) filter. Value of the utm_clicktype parameter, if present, in the URL associated with the metric. utmConfig: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Config (utm) filter. Value of the utm_config parameter, if present, in the URL associated with the metric. utmContent: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Content (utm) filter. Value of the utm_content parameter, if present, in the URL associated with the metric. utmCreativeFormat: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Creative Format (utm) filter. Value of the utm_creative_format parameter, if present, in the URL associated with the metric. utmCreativeid: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Creative ID (utm) filter. Value of the utm_creativeid parameter, if present, in the URL associated with the metric. utmFormat: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Format (utm) filter. Value of the utm_format parameter, if present, in the URL associated with the metric. utmId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: ID (utm) filter. Value of the utm_id parameter, if present, in the URL associated with the metric. utmMarketingTactic: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Marketing Tactic filter. This dimension can be awareness, consideration, or conversion, depending on the presence of these strings in the URL associated with the metric. utmMedium: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Medium (utm) filter. Value of the utm_medium parameter, if present, in the URL associated with the metric. utmPlacement: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Placement (utm) filter. Value of the utm_placement parameter, if present, in the URL associated with the metric. utmPlacementId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Placement ID (utm) filter. Value of the utm_placementid parameter, if present, in the URL associated with the metric. utmSource: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Source (utm) filter. Value of the utm_source parameter, if present, in the URL associated with the metric. utmSourcePlatform: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Source Platform (utm) filter. Value of the utm_source_platform parameter, if present, in the URL associated with the metric. utmTerm: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Term (utm) filter. Value of the utm_term parameter, if present, in the URL associated with the metric. utmVariant: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Variant (utm) filter. Value of the utm_variant parameter, if present, in the URL associated with the metric. auraAdSpend: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for auraAdSpend (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. auraIncrementalContribution: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for auraIncrementalContribution (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. averageClickPrice: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for averageClickPrice (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. commerceLoadSessions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for commerceLoadSessions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. commerceLoads: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for commerceLoads (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. ctaView: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for ctaView (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. ctaViewSessions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for ctaViewSessions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. maxAuraRoas: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for maxAuraRoas (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. minAuraRoas: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for minAuraRoas (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. offlinePurchaseIntentClicks: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for offlinePurchaseIntentClicks (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. onlinePurchaseIntentClicks: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for onlinePurchaseIntentClicks (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentClickSessions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentClickSessions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentClicks: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentClicks (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentRate: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentRate (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentRateSession: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentRateSession (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentValue: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentValue (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. rawSalesAccountAmount: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for rawSalesAccountAmount (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. rawSalesAmount: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for rawSalesAmount (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerCTR: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerCTR (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerDisplayRate: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerDisplayRate (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerDisplayed: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerDisplayed (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerInStock: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerInStock (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerInStockRate: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerInStockRate (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerOutOfStock: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerOutOfStock (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. skuSelected: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for skuSelected (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. successfulSearches: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for successfulSearches (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. transactions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for transactions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. unsuccessfulSearches: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for unsuccessfulSearches (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. additionalProperties: false type: object title: Filters description: 'Per-field filters: each dimension key uses a typed filter object (e.g. country/shopperCountry require ISO 3166-1 alpha-2 codes; commerceType uses CommerceType codes; subaccountId/experience use 24-char ObjectIds; coded dimensions expose includes/excludes only). Metrics may use is_higher_than / is_lower_than (post-aggregation).' accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL maxLength: 3 minLength: 3 title: Currency description: The Currency field is required in the request body to provide the monetary metrics in the adequate currency. fieldDetails: anyOf: - type: string - type: 'null' title: Fielddetails description: When set to 'yes', includes tooltip and category fields in the response. startDate: type: string format: date title: Startdate endDate: type: string format: date title: Enddate subaccountIds: anyOf: - items: type: string type: array - type: 'null' title: Subaccountids default: [] filtersJoinOperator: anyOf: - type: string - type: 'null' title: Filtersjoinoperator description: 'How to combine top-level filter conditions: AND (default) or OR. Case-insensitive.' default: AND type: object required: - dimensions - metrics - filters - accountId - currency - startDate - endDate title: CustomReportFacetsRequestBody description: 'POST /custom_report_filters: do not reject substring filters (not applied in SQL for these dims).' CustomReportFieldsRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: items: $ref: '#/components/schemas/Dimensions' type: array title: Filters description: Filters are used to filter the data based on the selected dimensions. Only provide the filter labels and not the filter values. accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL maxLength: 3 minLength: 3 title: Currency description: The Currency field is required in the request body to provide the monetary metrics in the adequate currency. fieldDetails: anyOf: - type: string - type: 'null' title: Fielddetails description: When set to 'yes', includes tooltip and category fields in the response. startDate: anyOf: - type: string format: date - type: 'null' title: Startdate description: Optional report range start. When provided with field_details 'yes', tooltips for metrics/dimensions with a configured start_date include a warning only if this date is before that field's availability date. useAdvancedFilters: type: boolean title: Useadvancedfilters description: When true, filters may use advanced-only fields (e.g. utmPlacement). When false or omitted, filters may only use base filter dimensions. default: false subaccountIds: anyOf: - items: type: string type: array - type: 'null' title: Subaccountids description: Optional subaccount IDs for Aura metric eligibility. type: object required: - dimensions - metrics - filters - accountId - currency title: CustomReportFieldsRequestBody CustomReportPaginatedRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: properties: alternateProductName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Alternate Product Name filter. Alternate product name from the Catalog. brandEntity: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Reporting Brand filter. The Brand Entity associated with MikMak metrics. commerceType: anyOf: - $ref: '#/components/schemas/CommerceTypeFilters' - type: 'null' description: Commerce Type filter. Type of MikMak Commerce Experience (Brand.com, Media, etc.) country: anyOf: - $ref: '#/components/schemas/CountryFilters' - type: 'null' description: Country filter. Geographic country associated with the Commerce Experience. deviceType: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Device Type filter. The category of the visitor's hardware (Desktop, Mobile, Tablet, or Others), detected via the user agent associated with the metric. domainUrl: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Domain URL filter. The web domain associated with the metric. experience: anyOf: - $ref: '#/components/schemas/ObjectIdFilters' - type: 'null' description: Commerce Experience filter. Name of the Commerce Experience. isBundle: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Bundle filter. Whether the metric is tied to a bundle of products. modelName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Model Name filter. Model name from the Catalog. mpn: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: MPN filter. Manufacturer Part Number of the catalog product in the Commerce Experience. pageUrl: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Page URL filter. The web page associated with the metric. productBrandName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Brand Name filter. Brand of the catalog product in the Commerce Experience. productCategoryName: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Product Category Name filter. Category of the catalog product in the Commerce Experience. productCustomCategory: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Category filter. Custom category of the catalog product in the Commerce Experience. productCustomSubcategory1: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 1 filter. Custom subcategory (level 1) of the catalog product in the Commerce Experience. productCustomSubcategory2: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 2 filter. Custom subcategory (level 2) of the catalog product in the Commerce Experience. productCustomSubcategory3: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 3 filter. Custom subcategory (level 3) of the catalog product in the Commerce Experience. productCustomSubcategory4: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 4 filter. Custom subcategory (level 4) of the catalog product in the Commerce Experience. productLine: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Product Line filter. Line of the catalog product in the Commerce Experience. productName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Name filter. Name of the catalog product in the Commerce Experience. productRange: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Product Range filter. Range of the catalog product in the Commerce Experience. retailer: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Retailer Name filter. Name of the online or offline retailer associated with a click or transaction. shopperCity: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Shopper City filter. The city, town, or municipality where the shopper was located during the session. shopperCountry: anyOf: - $ref: '#/components/schemas/CountryFilters' - type: 'null' description: Shopper Country filter. The country where the shopper was located during the session. shopperRegion: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Shopper Region filter. The primary administrative division (e.g., State, Province, or Region, dependent on the country) where the shopper was located during the session. shopperZipCode: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Shopper Zip Code filter. The local postal code or ZIP code associated with the shopper's location. standardMedium: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Standard Medium filter. The categorized version of the utm_medium parameter, mapping various raw values into a standardized set of marketing mediums. standardSource: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Standard Source filter. The categorized version of the utm_source parameter, mapping various raw values into a standardized set of traffic sources. subaccountId: anyOf: - $ref: '#/components/schemas/ObjectIdFilters' - type: 'null' description: Subaccount filter. MikMak subaccount that contains the Experience associated with the metric. utmAdId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Ad ID (utm) filter. Value of the utm_adid parameter, if present, in the URL associated with the metric. utmAdvertiserId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Advertiser ID (utm) filter. Value of the utm_advertiserid parameter, if present, in the URL associated with the metric. utmBu: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Business Unit (utm) filter. Value of the utm_bu parameter, if present, in the URL associated with the metric. utmCampaign: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Campaign (utm) filter. Value of the utm_campaign parameter, if present, in the URL associated with the metric. utmClicktype: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Click Type (utm) filter. Value of the utm_clicktype parameter, if present, in the URL associated with the metric. utmConfig: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Config (utm) filter. Value of the utm_config parameter, if present, in the URL associated with the metric. utmContent: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Content (utm) filter. Value of the utm_content parameter, if present, in the URL associated with the metric. utmCreativeFormat: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Creative Format (utm) filter. Value of the utm_creative_format parameter, if present, in the URL associated with the metric. utmCreativeid: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Creative ID (utm) filter. Value of the utm_creativeid parameter, if present, in the URL associated with the metric. utmFormat: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Format (utm) filter. Value of the utm_format parameter, if present, in the URL associated with the metric. utmId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: ID (utm) filter. Value of the utm_id parameter, if present, in the URL associated with the metric. utmMarketingTactic: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Marketing Tactic filter. This dimension can be awareness, consideration, or conversion, depending on the presence of these strings in the URL associated with the metric. utmMedium: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Medium (utm) filter. Value of the utm_medium parameter, if present, in the URL associated with the metric. utmPlacement: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Placement (utm) filter. Value of the utm_placement parameter, if present, in the URL associated with the metric. utmPlacementId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Placement ID (utm) filter. Value of the utm_placementid parameter, if present, in the URL associated with the metric. utmSource: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Source (utm) filter. Value of the utm_source parameter, if present, in the URL associated with the metric. utmSourcePlatform: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Source Platform (utm) filter. Value of the utm_source_platform parameter, if present, in the URL associated with the metric. utmTerm: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Term (utm) filter. Value of the utm_term parameter, if present, in the URL associated with the metric. utmVariant: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Variant (utm) filter. Value of the utm_variant parameter, if present, in the URL associated with the metric. auraAdSpend: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for auraAdSpend (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. auraIncrementalContribution: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for auraIncrementalContribution (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. averageClickPrice: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for averageClickPrice (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. commerceLoadSessions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for commerceLoadSessions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. commerceLoads: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for commerceLoads (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. ctaView: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for ctaView (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. ctaViewSessions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for ctaViewSessions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. maxAuraRoas: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for maxAuraRoas (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. minAuraRoas: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for minAuraRoas (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. offlinePurchaseIntentClicks: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for offlinePurchaseIntentClicks (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. onlinePurchaseIntentClicks: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for onlinePurchaseIntentClicks (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentClickSessions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentClickSessions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentClicks: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentClicks (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentRate: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentRate (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentRateSession: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentRateSession (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentValue: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentValue (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. rawSalesAccountAmount: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for rawSalesAccountAmount (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. rawSalesAmount: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for rawSalesAmount (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerCTR: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerCTR (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerDisplayRate: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerDisplayRate (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerDisplayed: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerDisplayed (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerInStock: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerInStock (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerInStockRate: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerInStockRate (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerOutOfStock: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerOutOfStock (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. skuSelected: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for skuSelected (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. successfulSearches: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for successfulSearches (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. transactions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for transactions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. unsuccessfulSearches: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for unsuccessfulSearches (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. additionalProperties: false type: object title: Filters description: 'Per-field filters: each dimension key uses a typed filter object (e.g. country/shopperCountry require ISO 3166-1 alpha-2 codes; commerceType uses CommerceType codes; subaccountId/experience use 24-char ObjectIds; coded dimensions expose includes/excludes only). Metrics may use is_higher_than / is_lower_than (post-aggregation).' accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL maxLength: 3 minLength: 3 title: Currency description: The Currency field is required in the request body to provide the monetary metrics in the adequate currency. fieldDetails: anyOf: - type: string - type: 'null' title: Fielddetails description: When set to 'yes', includes tooltip and category fields in the response. startDate: type: string format: date title: Startdate endDate: type: string format: date title: Enddate subaccountIds: anyOf: - items: type: string type: array - type: 'null' title: Subaccountids default: [] filtersJoinOperator: anyOf: - type: string - type: 'null' title: Filtersjoinoperator description: 'How to combine top-level filter conditions: AND (default) or OR. Case-insensitive.' default: AND useAdvancedFilters: type: boolean title: Useadvancedfilters description: When true, filters may use advanced-only fields (e.g. utmPlacement). When false or omitted, filters may only use base filter dimensions. default: false sortBy: type: string enum: - date - country - currency - productBrandName - experience - commerceType - productName - alternateProductName - modelName - retailer - utmSource - utmMedium - utmCampaign - utmTerm - utmContent - utmAdId - utmPlacement - utmBu - utmClicktype - utmVariant - utmAdvertiserId - utmPlacementId - utmFormat - utmCreativeid - utmConfig - utmId - utmMarketingTactic - utmSourcePlatform - utmCreativeFormat - standardSource - standardMedium - productCategoryName - productLine - productRange - productCustomCategory - productCustomSubcategory1 - productCustomSubcategory2 - productCustomSubcategory3 - productCustomSubcategory4 - subaccountId - ean - mpn - partnerId - recipeName - recipeRetailer - recipeUtmSource - recipeUtmMedium - recipeUtmCampaign - domain - pageUrl - domainUrl - shopperCity - shopperRegion - shopperCountry - shopperZipCode - brandEntity - isBundle - deviceType - purchaseIntentValue - averageClickPrice - purchaseIntentClicks - ctaView - rawSalesAccountAmount - rawSalesAmount - commerceLoads - purchaseIntentRate - ctaViewSessions - commerceLoadSessions - purchaseIntentClickSessions - purchaseIntentRateSession - transactions - skuSelected - successfulSearches - unsuccessfulSearches - onlinePurchaseIntentClicks - offlinePurchaseIntentClicks - avgPriceLocalCurrency - minPriceLocalCurrency - maxPriceLocalCurrency - medianPriceLocalCurrency - inStock - outOfStock - retailerOpportunities - missedRetailerOpportunities - retailerImpressions - retailerDisplayed - retailerInStock - retailerOutOfStock - retailerInStockRate - retailerDisplayRate - retailerCTR - transactionValue - commerceLoadedRate - shoppableCommerceLoadedRate - visitorConversionRate - shoppableTransactionConversionRate - shoppableTransactionValueConversionRate - minAuraRoas - maxAuraRoas - auraAdSpend - auraIncrementalContribution title: Sortby sortDir: $ref: '#/components/schemas/OrderDirection' dateFreq: $ref: '#/components/schemas/DateFreq' default: D offset: type: integer minimum: 0 title: Offset count: type: integer maximum: 10000 minimum: 1 title: Count type: object required: - dimensions - metrics - filters - accountId - currency - startDate - endDate - sortBy - sortDir - offset - count title: CustomReportPaginatedRequestBody CustomReportRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: properties: alternateProductName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Alternate Product Name filter. Alternate product name from the Catalog. brandEntity: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Reporting Brand filter. The Brand Entity associated with MikMak metrics. commerceType: anyOf: - $ref: '#/components/schemas/CommerceTypeFilters' - type: 'null' description: Commerce Type filter. Type of MikMak Commerce Experience (Brand.com, Media, etc.) country: anyOf: - $ref: '#/components/schemas/CountryFilters' - type: 'null' description: Country filter. Geographic country associated with the Commerce Experience. deviceType: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Device Type filter. The category of the visitor's hardware (Desktop, Mobile, Tablet, or Others), detected via the user agent associated with the metric. domainUrl: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Domain URL filter. The web domain associated with the metric. experience: anyOf: - $ref: '#/components/schemas/ObjectIdFilters' - type: 'null' description: Commerce Experience filter. Name of the Commerce Experience. isBundle: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Bundle filter. Whether the metric is tied to a bundle of products. modelName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Model Name filter. Model name from the Catalog. mpn: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: MPN filter. Manufacturer Part Number of the catalog product in the Commerce Experience. pageUrl: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Page URL filter. The web page associated with the metric. productBrandName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Brand Name filter. Brand of the catalog product in the Commerce Experience. productCategoryName: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Product Category Name filter. Category of the catalog product in the Commerce Experience. productCustomCategory: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Category filter. Custom category of the catalog product in the Commerce Experience. productCustomSubcategory1: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 1 filter. Custom subcategory (level 1) of the catalog product in the Commerce Experience. productCustomSubcategory2: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 2 filter. Custom subcategory (level 2) of the catalog product in the Commerce Experience. productCustomSubcategory3: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 3 filter. Custom subcategory (level 3) of the catalog product in the Commerce Experience. productCustomSubcategory4: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 4 filter. Custom subcategory (level 4) of the catalog product in the Commerce Experience. productLine: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Product Line filter. Line of the catalog product in the Commerce Experience. productName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Name filter. Name of the catalog product in the Commerce Experience. productRange: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Product Range filter. Range of the catalog product in the Commerce Experience. retailer: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Retailer Name filter. Name of the online or offline retailer associated with a click or transaction. shopperCity: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Shopper City filter. The city, town, or municipality where the shopper was located during the session. shopperCountry: anyOf: - $ref: '#/components/schemas/CountryFilters' - type: 'null' description: Shopper Country filter. The country where the shopper was located during the session. shopperRegion: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Shopper Region filter. The primary administrative division (e.g., State, Province, or Region, dependent on the country) where the shopper was located during the session. shopperZipCode: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Shopper Zip Code filter. The local postal code or ZIP code associated with the shopper's location. standardMedium: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Standard Medium filter. The categorized version of the utm_medium parameter, mapping various raw values into a standardized set of marketing mediums. standardSource: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Standard Source filter. The categorized version of the utm_source parameter, mapping various raw values into a standardized set of traffic sources. subaccountId: anyOf: - $ref: '#/components/schemas/ObjectIdFilters' - type: 'null' description: Subaccount filter. MikMak subaccount that contains the Experience associated with the metric. utmAdId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Ad ID (utm) filter. Value of the utm_adid parameter, if present, in the URL associated with the metric. utmAdvertiserId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Advertiser ID (utm) filter. Value of the utm_advertiserid parameter, if present, in the URL associated with the metric. utmBu: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Business Unit (utm) filter. Value of the utm_bu parameter, if present, in the URL associated with the metric. utmCampaign: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Campaign (utm) filter. Value of the utm_campaign parameter, if present, in the URL associated with the metric. utmClicktype: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Click Type (utm) filter. Value of the utm_clicktype parameter, if present, in the URL associated with the metric. utmConfig: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Config (utm) filter. Value of the utm_config parameter, if present, in the URL associated with the metric. utmContent: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Content (utm) filter. Value of the utm_content parameter, if present, in the URL associated with the metric. utmCreativeFormat: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Creative Format (utm) filter. Value of the utm_creative_format parameter, if present, in the URL associated with the metric. utmCreativeid: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Creative ID (utm) filter. Value of the utm_creativeid parameter, if present, in the URL associated with the metric. utmFormat: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Format (utm) filter. Value of the utm_format parameter, if present, in the URL associated with the metric. utmId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: ID (utm) filter. Value of the utm_id parameter, if present, in the URL associated with the metric. utmMarketingTactic: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Marketing Tactic filter. This dimension can be awareness, consideration, or conversion, depending on the presence of these strings in the URL associated with the metric. utmMedium: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Medium (utm) filter. Value of the utm_medium parameter, if present, in the URL associated with the metric. utmPlacement: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Placement (utm) filter. Value of the utm_placement parameter, if present, in the URL associated with the metric. utmPlacementId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Placement ID (utm) filter. Value of the utm_placementid parameter, if present, in the URL associated with the metric. utmSource: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Source (utm) filter. Value of the utm_source parameter, if present, in the URL associated with the metric. utmSourcePlatform: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Source Platform (utm) filter. Value of the utm_source_platform parameter, if present, in the URL associated with the metric. utmTerm: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Term (utm) filter. Value of the utm_term parameter, if present, in the URL associated with the metric. utmVariant: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Variant (utm) filter. Value of the utm_variant parameter, if present, in the URL associated with the metric. auraAdSpend: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for auraAdSpend (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. auraIncrementalContribution: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for auraIncrementalContribution (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. averageClickPrice: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for averageClickPrice (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. commerceLoadSessions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for commerceLoadSessions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. commerceLoads: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for commerceLoads (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. ctaView: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for ctaView (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. ctaViewSessions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for ctaViewSessions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. maxAuraRoas: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for maxAuraRoas (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. minAuraRoas: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for minAuraRoas (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. offlinePurchaseIntentClicks: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for offlinePurchaseIntentClicks (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. onlinePurchaseIntentClicks: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for onlinePurchaseIntentClicks (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentClickSessions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentClickSessions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentClicks: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentClicks (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentRate: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentRate (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentRateSession: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentRateSession (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentValue: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentValue (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. rawSalesAccountAmount: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for rawSalesAccountAmount (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. rawSalesAmount: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for rawSalesAmount (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerCTR: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerCTR (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerDisplayRate: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerDisplayRate (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerDisplayed: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerDisplayed (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerInStock: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerInStock (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerInStockRate: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerInStockRate (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerOutOfStock: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerOutOfStock (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. skuSelected: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for skuSelected (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. successfulSearches: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for successfulSearches (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. transactions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for transactions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. unsuccessfulSearches: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for unsuccessfulSearches (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. additionalProperties: false type: object title: Filters description: 'Per-field filters: each dimension key uses a typed filter object (e.g. country/shopperCountry require ISO 3166-1 alpha-2 codes; commerceType uses CommerceType codes; subaccountId/experience use 24-char ObjectIds; coded dimensions expose includes/excludes only). Metrics may use is_higher_than / is_lower_than (post-aggregation).' accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL maxLength: 3 minLength: 3 title: Currency description: The Currency field is required in the request body to provide the monetary metrics in the adequate currency. fieldDetails: anyOf: - type: string - type: 'null' title: Fielddetails description: When set to 'yes', includes tooltip and category fields in the response. startDate: type: string format: date title: Startdate endDate: type: string format: date title: Enddate subaccountIds: anyOf: - items: type: string type: array - type: 'null' title: Subaccountids default: [] filtersJoinOperator: anyOf: - type: string - type: 'null' title: Filtersjoinoperator description: 'How to combine top-level filter conditions: AND (default) or OR. Case-insensitive.' default: AND useAdvancedFilters: type: boolean title: Useadvancedfilters description: When true, filters may use advanced-only fields (e.g. utmPlacement). When false or omitted, filters may only use base filter dimensions. default: false sortBy: type: string enum: - date - country - currency - productBrandName - experience - commerceType - productName - alternateProductName - modelName - retailer - utmSource - utmMedium - utmCampaign - utmTerm - utmContent - utmAdId - utmPlacement - utmBu - utmClicktype - utmVariant - utmAdvertiserId - utmPlacementId - utmFormat - utmCreativeid - utmConfig - utmId - utmMarketingTactic - utmSourcePlatform - utmCreativeFormat - standardSource - standardMedium - productCategoryName - productLine - productRange - productCustomCategory - productCustomSubcategory1 - productCustomSubcategory2 - productCustomSubcategory3 - productCustomSubcategory4 - subaccountId - ean - mpn - partnerId - recipeName - recipeRetailer - recipeUtmSource - recipeUtmMedium - recipeUtmCampaign - domain - pageUrl - domainUrl - shopperCity - shopperRegion - shopperCountry - shopperZipCode - brandEntity - isBundle - deviceType - purchaseIntentValue - averageClickPrice - purchaseIntentClicks - ctaView - rawSalesAccountAmount - rawSalesAmount - commerceLoads - purchaseIntentRate - ctaViewSessions - commerceLoadSessions - purchaseIntentClickSessions - purchaseIntentRateSession - transactions - skuSelected - successfulSearches - unsuccessfulSearches - onlinePurchaseIntentClicks - offlinePurchaseIntentClicks - avgPriceLocalCurrency - minPriceLocalCurrency - maxPriceLocalCurrency - medianPriceLocalCurrency - inStock - outOfStock - retailerOpportunities - missedRetailerOpportunities - retailerImpressions - retailerDisplayed - retailerInStock - retailerOutOfStock - retailerInStockRate - retailerDisplayRate - retailerCTR - transactionValue - commerceLoadedRate - shoppableCommerceLoadedRate - visitorConversionRate - shoppableTransactionConversionRate - shoppableTransactionValueConversionRate - minAuraRoas - maxAuraRoas - auraAdSpend - auraIncrementalContribution title: Sortby sortDir: $ref: '#/components/schemas/OrderDirection' dateFreq: $ref: '#/components/schemas/DateFreq' default: D type: object required: - dimensions - metrics - filters - accountId - currency - startDate - endDate - sortBy - sortDir title: CustomReportRequestBody CustomReportSingleFilterRequestBody: properties: startDate: type: string format: date title: Startdate description: Start of the date range. endDate: type: string format: date title: Enddate description: End of the date range. filter: type: string title: Filter description: Single dimension to get filter values for (e.g. 'country' or 'utmCampaign'). accountId: type: string title: Accountid description: Account ID; if not provided, taken from the token. subaccountIds: anyOf: - items: type: string type: array - type: 'null' title: Subaccountids description: Optional list of subaccount IDs to restrict the query. default: [] type: object required: - startDate - endDate - filter - accountId title: CustomReportSingleFilterRequestBody description: Request body for retrieving filter values for a single dimension (ignores other filters). CustomReportSummaryRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: properties: alternateProductName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Alternate Product Name filter. Alternate product name from the Catalog. brandEntity: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Reporting Brand filter. The Brand Entity associated with MikMak metrics. commerceType: anyOf: - $ref: '#/components/schemas/CommerceTypeFilters' - type: 'null' description: Commerce Type filter. Type of MikMak Commerce Experience (Brand.com, Media, etc.) country: anyOf: - $ref: '#/components/schemas/CountryFilters' - type: 'null' description: Country filter. Geographic country associated with the Commerce Experience. deviceType: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Device Type filter. The category of the visitor's hardware (Desktop, Mobile, Tablet, or Others), detected via the user agent associated with the metric. domainUrl: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Domain URL filter. The web domain associated with the metric. experience: anyOf: - $ref: '#/components/schemas/ObjectIdFilters' - type: 'null' description: Commerce Experience filter. Name of the Commerce Experience. isBundle: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Bundle filter. Whether the metric is tied to a bundle of products. modelName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Model Name filter. Model name from the Catalog. mpn: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: MPN filter. Manufacturer Part Number of the catalog product in the Commerce Experience. pageUrl: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Page URL filter. The web page associated with the metric. productBrandName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Brand Name filter. Brand of the catalog product in the Commerce Experience. productCategoryName: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Product Category Name filter. Category of the catalog product in the Commerce Experience. productCustomCategory: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Category filter. Custom category of the catalog product in the Commerce Experience. productCustomSubcategory1: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 1 filter. Custom subcategory (level 1) of the catalog product in the Commerce Experience. productCustomSubcategory2: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 2 filter. Custom subcategory (level 2) of the catalog product in the Commerce Experience. productCustomSubcategory3: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 3 filter. Custom subcategory (level 3) of the catalog product in the Commerce Experience. productCustomSubcategory4: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Custom Subcategory 4 filter. Custom subcategory (level 4) of the catalog product in the Commerce Experience. productLine: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Product Line filter. Line of the catalog product in the Commerce Experience. productName: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Product Name filter. Name of the catalog product in the Commerce Experience. productRange: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Product Range filter. Range of the catalog product in the Commerce Experience. retailer: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Retailer Name filter. Name of the online or offline retailer associated with a click or transaction. shopperCity: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Shopper City filter. The city, town, or municipality where the shopper was located during the session. shopperCountry: anyOf: - $ref: '#/components/schemas/CountryFilters' - type: 'null' description: Shopper Country filter. The country where the shopper was located during the session. shopperRegion: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Shopper Region filter. The primary administrative division (e.g., State, Province, or Region, dependent on the country) where the shopper was located during the session. shopperZipCode: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Shopper Zip Code filter. The local postal code or ZIP code associated with the shopper's location. standardMedium: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Standard Medium filter. The categorized version of the utm_medium parameter, mapping various raw values into a standardized set of marketing mediums. standardSource: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Standard Source filter. The categorized version of the utm_source parameter, mapping various raw values into a standardized set of traffic sources. subaccountId: anyOf: - $ref: '#/components/schemas/ObjectIdFilters' - type: 'null' description: Subaccount filter. MikMak subaccount that contains the Experience associated with the metric. utmAdId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Ad ID (utm) filter. Value of the utm_adid parameter, if present, in the URL associated with the metric. utmAdvertiserId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Advertiser ID (utm) filter. Value of the utm_advertiserid parameter, if present, in the URL associated with the metric. utmBu: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Business Unit (utm) filter. Value of the utm_bu parameter, if present, in the URL associated with the metric. utmCampaign: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Campaign (utm) filter. Value of the utm_campaign parameter, if present, in the URL associated with the metric. utmClicktype: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Click Type (utm) filter. Value of the utm_clicktype parameter, if present, in the URL associated with the metric. utmConfig: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Config (utm) filter. Value of the utm_config parameter, if present, in the URL associated with the metric. utmContent: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Content (utm) filter. Value of the utm_content parameter, if present, in the URL associated with the metric. utmCreativeFormat: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Creative Format (utm) filter. Value of the utm_creative_format parameter, if present, in the URL associated with the metric. utmCreativeid: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Creative ID (utm) filter. Value of the utm_creativeid parameter, if present, in the URL associated with the metric. utmFormat: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Format (utm) filter. Value of the utm_format parameter, if present, in the URL associated with the metric. utmId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: ID (utm) filter. Value of the utm_id parameter, if present, in the URL associated with the metric. utmMarketingTactic: anyOf: - $ref: '#/components/schemas/CodedStrFilters' - type: 'null' description: Marketing Tactic filter. This dimension can be awareness, consideration, or conversion, depending on the presence of these strings in the URL associated with the metric. utmMedium: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Medium (utm) filter. Value of the utm_medium parameter, if present, in the URL associated with the metric. utmPlacement: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Placement (utm) filter. Value of the utm_placement parameter, if present, in the URL associated with the metric. utmPlacementId: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Placement ID (utm) filter. Value of the utm_placementid parameter, if present, in the URL associated with the metric. utmSource: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Source (utm) filter. Value of the utm_source parameter, if present, in the URL associated with the metric. utmSourcePlatform: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Source Platform (utm) filter. Value of the utm_source_platform parameter, if present, in the URL associated with the metric. utmTerm: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Term (utm) filter. Value of the utm_term parameter, if present, in the URL associated with the metric. utmVariant: anyOf: - $ref: '#/components/schemas/StrFilters' - type: 'null' description: Variant (utm) filter. Value of the utm_variant parameter, if present, in the URL associated with the metric. auraAdSpend: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for auraAdSpend (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. auraIncrementalContribution: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for auraIncrementalContribution (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. averageClickPrice: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for averageClickPrice (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. commerceLoadSessions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for commerceLoadSessions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. commerceLoads: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for commerceLoads (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. ctaView: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for ctaView (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. ctaViewSessions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for ctaViewSessions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. maxAuraRoas: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for maxAuraRoas (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. minAuraRoas: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for minAuraRoas (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. offlinePurchaseIntentClicks: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for offlinePurchaseIntentClicks (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. onlinePurchaseIntentClicks: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for onlinePurchaseIntentClicks (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentClickSessions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentClickSessions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentClicks: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentClicks (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentRate: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentRate (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentRateSession: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentRateSession (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. purchaseIntentValue: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for purchaseIntentValue (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. rawSalesAccountAmount: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for rawSalesAccountAmount (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. rawSalesAmount: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for rawSalesAmount (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerCTR: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerCTR (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerDisplayRate: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerDisplayRate (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerDisplayed: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerDisplayed (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerInStock: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerInStock (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerInStockRate: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerInStockRate (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. retailerOutOfStock: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for retailerOutOfStock (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. skuSelected: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for skuSelected (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. successfulSearches: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for successfulSearches (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. transactions: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for transactions (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. unsuccessfulSearches: anyOf: - $ref: '#/components/schemas/MetricNumericFilterRule' - type: 'null' description: Post-aggregation numeric bounds for unsuccessfulSearches (is_higher_than / is_lower_than). At most one metric may use numeric filters per request; the metric must also be listed in 'metrics'. additionalProperties: false type: object title: Filters description: 'Per-field filters: each dimension key uses a typed filter object (e.g. country/shopperCountry require ISO 3166-1 alpha-2 codes; commerceType uses CommerceType codes; subaccountId/experience use 24-char ObjectIds; coded dimensions expose includes/excludes only). Metrics may use is_higher_than / is_lower_than (post-aggregation).' accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL maxLength: 3 minLength: 3 title: Currency description: The Currency field is required in the request body to provide the monetary metrics in the adequate currency. fieldDetails: anyOf: - type: string - type: 'null' title: Fielddetails description: When set to 'yes', includes tooltip and category fields in the response. startDate: type: string format: date title: Startdate endDate: type: string format: date title: Enddate subaccountIds: anyOf: - items: type: string type: array - type: 'null' title: Subaccountids default: [] filtersJoinOperator: anyOf: - type: string - type: 'null' title: Filtersjoinoperator description: 'How to combine top-level filter conditions: AND (default) or OR. Case-insensitive.' default: AND useAdvancedFilters: type: boolean title: Useadvancedfilters description: When true, filters may use advanced-only fields (e.g. utmPlacement). When false or omitted, filters may only use base filter dimensions. default: false dateFreq: $ref: '#/components/schemas/DateFreq' default: D type: object required: - dimensions - metrics - filters - accountId - currency - startDate - endDate title: CustomReportSummaryRequestBody DateFreq: type: string enum: - D - W - M - Q - Y title: DateFreq description: 'Date bucket granularity for time-series reports. Members: - D: Daily (one row per calendar day). - W: Weekly (one row per ISO week, Monday-starting). - M: Monthly (one row per calendar month). - Q: Quarterly (one row per calendar quarter). - Y: Yearly (one row per calendar year).' Dimensions: type: string enum: - date - country - currency - productBrandName - experience - commerceType - productName - alternateProductName - modelName - retailer - utmSource - utmMedium - utmCampaign - utmTerm - utmContent - utmAdId - utmPlacement - utmBu - utmClicktype - utmVariant - utmAdvertiserId - utmPlacementId - utmFormat - utmCreativeid - utmConfig - utmId - utmMarketingTactic - utmSourcePlatform - utmCreativeFormat - standardSource - standardMedium - productCategoryName - productLine - productRange - productCustomCategory - productCustomSubcategory1 - productCustomSubcategory2 - productCustomSubcategory3 - productCustomSubcategory4 - subaccountId - ean - mpn - partnerId - recipeName - recipeRetailer - recipeUtmSource - recipeUtmMedium - recipeUtmCampaign - domain - pageUrl - domainUrl - shopperCity - shopperRegion - shopperCountry - shopperZipCode - brandEntity - isBundle - deviceType title: Dimensions description: 'Dimensions available in custom reports (groupable columns). Members: - date: Date associated with the metric. - country: Geographic country associated with the Commerce Experience. Filter with 2-character ISO 3166-1 alpha-2 codes (e.g. FR, US), not full names like France. - currency: Currency code used in the report. - productBrandName: Brand of the catalog product in the Commerce Experience. - experience: Name of the Commerce Experience. - commerceType: Type of MikMak Commerce Experience (Brand.com, Media, etc.); see ``CommerceType``. - productName: Name of the catalog product in the Commerce Experience. - retailer: Name of the online or offline retailer associated with a click or transaction. - utmSource: Value of the utm_source URL parameter. - utmMedium: Value of the utm_medium URL parameter. - utmCampaign: Value of the utm_campaign URL parameter. - utmTerm: Value of the utm_term URL parameter. - utmContent: Value of the utm_content URL parameter. - utmAdId: Value of the utm_adid URL parameter. - utmPlacement: Value of the utm_placement URL parameter. - utmBu: Value of the utm_bu (business unit) URL parameter. - utmClicktype: Value of the utm_clicktype URL parameter. - utmVariant: Value of the utm_variant URL parameter. - utmAdvertiserId: Value of the utm_advertiserid URL parameter. - utmPlacementId: Value of the utm_placementid URL parameter. - utmFormat: Value of the utm_format URL parameter. - utmCreativeid: Value of the utm_creativeid URL parameter. - utmConfig: Value of the utm_config URL parameter. - utmId: Value of the utm_id URL parameter. - utmMarketingTactic: Marketing tactic derived from the URL (awareness / consideration / conversion). - utmSourcePlatform: Value of the utm_source_platform URL parameter. - utmCreativeFormat: Value of the utm_creative_format URL parameter. - standardSource: Categorized version of utm_source mapped to a standardized traffic-source set. - standardMedium: Categorized version of utm_medium mapped to a standardized medium set. - productCategoryName: Category of the catalog product in the Commerce Experience. - productLine: Product line of the catalog product. - productRange: Product range of the catalog product. - productCustomCategory: Account-defined custom category of the catalog product. - productCustomSubcategory1: Account-defined custom subcategory (level 1). - productCustomSubcategory2: Account-defined custom subcategory (level 2). - productCustomSubcategory3: Account-defined custom subcategory (level 3). - productCustomSubcategory4: Account-defined custom subcategory (level 4). - subaccountId: MikMak subaccount (operator) that owns the Commerce Experience; PyObjectId-shaped. - ean: EAN product identifier. - partnerId: Name associated with a Recipe Partnership (shoppable recipes). - recipeName: Title of the shoppable recipe. - recipeRetailer: Retailer associated with a shoppable recipe click or transaction. - recipeUtmSource: utm_source for shoppable-recipe traffic. - recipeUtmMedium: utm_medium for shoppable-recipe traffic. - recipeUtmCampaign: utm_campaign for shoppable-recipe traffic. - domain: Website hosting the shoppable recipe. - pageUrl: Web page URL associated with the metric. - domainUrl: Web domain URL associated with the metric. - shopperCity: City, town or municipality of the shopper during the session. - shopperRegion: State/Province/Region of the shopper (country-dependent). - shopperCountry: Country of the shopper during the session. Filter with 2-character ISO 3166-1 alpha-2 codes (e.g. FR, US), not full names like France. - shopperZipCode: Local postal/ZIP code of the shopper''s location. - brandEntity: Reporting Brand (Aura-gated). - isBundle: Whether the experience is a bundle (Yes or No). - deviceType: The category of the visitor''s hardware (Desktop, Mobile, Tablet, or Others), detected via the user agent associated with the metric.' ExportResponse: properties: url: type: string title: Url type: object required: - url title: ExportResponse Health: properties: status: type: string title: Status type: object required: - status title: Health HistoricalPricingReportFieldsRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: items: $ref: '#/components/schemas/Dimensions' type: array title: Filters description: Filters are used to filter the data based on the selected dimensions. Only provide the filter labels and not the filter values. accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. type: object required: - dimensions - metrics - filters - accountId title: HistoricalPricingReportFieldsRequestBody HistoricalPricingReportFiltersRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: additionalProperties: anyOf: - $ref: '#/components/schemas/IntFilters' - $ref: '#/components/schemas/StrFilters' propertyNames: $ref: '#/components/schemas/Dimensions' type: object title: Filters accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. startDate: type: string format: date title: Startdate endDate: type: string format: date title: Enddate type: object required: - dimensions - metrics - filters - accountId - startDate - endDate title: HistoricalPricingReportFiltersRequestBody HistoricalPricingReportPaginatedRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: additionalProperties: anyOf: - $ref: '#/components/schemas/IntFilters' - $ref: '#/components/schemas/StrFilters' propertyNames: $ref: '#/components/schemas/Dimensions' type: object title: Filters accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. startDate: type: string format: date title: Startdate endDate: type: string format: date title: Enddate dateFreq: $ref: '#/components/schemas/DateFreq' default: D sortBy: type: string enum: - date - country - currency - productBrandName - experience - commerceType - productName - alternateProductName - modelName - retailer - utmSource - utmMedium - utmCampaign - utmTerm - utmContent - utmAdId - utmPlacement - utmBu - utmClicktype - utmVariant - utmAdvertiserId - utmPlacementId - utmFormat - utmCreativeid - utmConfig - utmId - utmMarketingTactic - utmSourcePlatform - utmCreativeFormat - standardSource - standardMedium - productCategoryName - productLine - productRange - productCustomCategory - productCustomSubcategory1 - productCustomSubcategory2 - productCustomSubcategory3 - productCustomSubcategory4 - subaccountId - ean - mpn - partnerId - recipeName - recipeRetailer - recipeUtmSource - recipeUtmMedium - recipeUtmCampaign - domain - pageUrl - domainUrl - shopperCity - shopperRegion - shopperCountry - shopperZipCode - brandEntity - isBundle - deviceType - purchaseIntentValue - averageClickPrice - purchaseIntentClicks - ctaView - rawSalesAccountAmount - rawSalesAmount - commerceLoads - purchaseIntentRate - ctaViewSessions - commerceLoadSessions - purchaseIntentClickSessions - purchaseIntentRateSession - transactions - skuSelected - successfulSearches - unsuccessfulSearches - onlinePurchaseIntentClicks - offlinePurchaseIntentClicks - avgPriceLocalCurrency - minPriceLocalCurrency - maxPriceLocalCurrency - medianPriceLocalCurrency - inStock - outOfStock - retailerOpportunities - missedRetailerOpportunities - retailerImpressions - retailerDisplayed - retailerInStock - retailerOutOfStock - retailerInStockRate - retailerDisplayRate - retailerCTR - transactionValue - commerceLoadedRate - shoppableCommerceLoadedRate - visitorConversionRate - shoppableTransactionConversionRate - shoppableTransactionValueConversionRate - minAuraRoas - maxAuraRoas - auraAdSpend - auraIncrementalContribution title: Sortby sortDir: $ref: '#/components/schemas/OrderDirection' offset: type: integer minimum: 0 title: Offset count: type: integer maximum: 10000 minimum: 1 title: Count type: object required: - dimensions - metrics - filters - accountId - startDate - endDate - sortBy - sortDir - offset - count title: HistoricalPricingReportPaginatedRequestBody HistoricalPricingReportRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: additionalProperties: anyOf: - $ref: '#/components/schemas/IntFilters' - $ref: '#/components/schemas/StrFilters' propertyNames: $ref: '#/components/schemas/Dimensions' type: object title: Filters accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. startDate: type: string format: date title: Startdate endDate: type: string format: date title: Enddate dateFreq: $ref: '#/components/schemas/DateFreq' default: D sortBy: type: string enum: - date - country - currency - productBrandName - experience - commerceType - productName - alternateProductName - modelName - retailer - utmSource - utmMedium - utmCampaign - utmTerm - utmContent - utmAdId - utmPlacement - utmBu - utmClicktype - utmVariant - utmAdvertiserId - utmPlacementId - utmFormat - utmCreativeid - utmConfig - utmId - utmMarketingTactic - utmSourcePlatform - utmCreativeFormat - standardSource - standardMedium - productCategoryName - productLine - productRange - productCustomCategory - productCustomSubcategory1 - productCustomSubcategory2 - productCustomSubcategory3 - productCustomSubcategory4 - subaccountId - ean - mpn - partnerId - recipeName - recipeRetailer - recipeUtmSource - recipeUtmMedium - recipeUtmCampaign - domain - pageUrl - domainUrl - shopperCity - shopperRegion - shopperCountry - shopperZipCode - brandEntity - isBundle - deviceType - purchaseIntentValue - averageClickPrice - purchaseIntentClicks - ctaView - rawSalesAccountAmount - rawSalesAmount - commerceLoads - purchaseIntentRate - ctaViewSessions - commerceLoadSessions - purchaseIntentClickSessions - purchaseIntentRateSession - transactions - skuSelected - successfulSearches - unsuccessfulSearches - onlinePurchaseIntentClicks - offlinePurchaseIntentClicks - avgPriceLocalCurrency - minPriceLocalCurrency - maxPriceLocalCurrency - medianPriceLocalCurrency - inStock - outOfStock - retailerOpportunities - missedRetailerOpportunities - retailerImpressions - retailerDisplayed - retailerInStock - retailerOutOfStock - retailerInStockRate - retailerDisplayRate - retailerCTR - transactionValue - commerceLoadedRate - shoppableCommerceLoadedRate - visitorConversionRate - shoppableTransactionConversionRate - shoppableTransactionValueConversionRate - minAuraRoas - maxAuraRoas - auraAdSpend - auraIncrementalContribution title: Sortby sortDir: $ref: '#/components/schemas/OrderDirection' type: object required: - dimensions - metrics - filters - accountId - startDate - endDate - sortBy - sortDir title: HistoricalPricingReportRequestBody HistoricalPricingReportSummaryRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: additionalProperties: anyOf: - $ref: '#/components/schemas/IntFilters' - $ref: '#/components/schemas/StrFilters' propertyNames: $ref: '#/components/schemas/Dimensions' type: object title: Filters accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. startDate: type: string format: date title: Startdate endDate: type: string format: date title: Enddate dateFreq: $ref: '#/components/schemas/DateFreq' default: D type: object required: - dimensions - metrics - filters - accountId - startDate - endDate title: HistoricalPricingReportSummaryRequestBody HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError IntFilters: properties: includes: items: type: integer type: array title: Includes additionalProperties: false type: object required: - includes title: IntFilters ListConfig: properties: apiFilterParam: type: string title: Apifilterparam displayName: type: string title: Displayname tooltip: anyOf: - type: string - type: 'null' title: Tooltip values: anyOf: - items: $ref: '#/components/schemas/ListItem' type: array - type: 'null' title: Values type: object required: - apiFilterParam - displayName title: ListConfig description: Menu item for providing a dropdown list of values with a display name ListItem: properties: label: type: string title: Label code: type: string title: Code tooltip: anyOf: - type: string - type: 'null' title: Tooltip category: anyOf: - type: string - type: 'null' title: Category startDate: anyOf: - type: string - type: 'null' title: Startdate type: object required: - label - code title: ListItem description: Values for displaying item in a list MetricDataType: type: string enum: - integer - percentage - currency - float - string - date title: MetricDataType description: 'Allowed ``dataType`` values in the advanced-filter metric metadata response. Members: - integer: Integer metric. - percentage: Percentage rate (0.0 - 100.0 conventionally). - currency: Monetary metric; the actual currency code comes from the request. - float: Floating-point numeric metric. - string: String metric (rare; string-typed aggregation). - date: Date metric.' MetricNumericFilterRule: additionalProperties: false description: 'Post-aggregation metric bounds: is_higher_than is >=, is_lower_than is <=.' properties: isHigherThan: anyOf: - type: number - type: 'null' default: null description: Inclusive lower bound on the aggregated metric (SQL >=). title: Ishigherthan isLowerThan: anyOf: - type: number - type: 'null' default: null description: Inclusive upper bound on the aggregated metric (SQL <=). title: Islowerthan title: MetricNumericFilterRule type: object Metrics: type: string enum: - purchaseIntentValue - averageClickPrice - purchaseIntentClicks - ctaView - rawSalesAccountAmount - rawSalesAmount - commerceLoads - purchaseIntentRate - ctaViewSessions - commerceLoadSessions - purchaseIntentClickSessions - purchaseIntentRateSession - transactions - skuSelected - successfulSearches - unsuccessfulSearches - onlinePurchaseIntentClicks - offlinePurchaseIntentClicks - avgPriceLocalCurrency - minPriceLocalCurrency - maxPriceLocalCurrency - medianPriceLocalCurrency - inStock - outOfStock - retailerOpportunities - missedRetailerOpportunities - retailerImpressions - retailerDisplayed - retailerInStock - retailerOutOfStock - retailerInStockRate - retailerDisplayRate - retailerCTR - transactionValue - commerceLoadedRate - shoppableCommerceLoadedRate - visitorConversionRate - shoppableTransactionConversionRate - shoppableTransactionValueConversionRate - minAuraRoas - maxAuraRoas - auraAdSpend - auraIncrementalContribution title: Metrics description: 'Metrics available in custom reports (aggregated numeric values). Members: - purchaseIntentValue: Total financial value of Purchase Intent Clicks (price x clicks), in the selected currency. - averageClickPrice: Average listed price of clicked products (Purchase Intent Value / Total Purchase Intent Clicks). - purchaseIntentClicks: Total number of clicks-through to a retailer from a MikMak Commerce Experience (online + offline). - ctaView: Times the MikMak button was present on a page (or immediately before an auto-loaded Experience). - rawSalesAccountAmount: Transaction value attributed to Purchase Intent Clicks, restricted to products associated with the account. - rawSalesAmount: Transaction value attributed to Purchase Intent Clicks across all products (including other brands''). - commerceLoads: Number of times a MikMak Commerce Experience was fully initialized. - purchaseIntentRate: Percentage of shoppers who opened an Experience and then clicked through to a retailer. - ctaViewSessions: Unique user sessions containing at least one CTA View. - commerceLoadSessions: Unique user sessions containing at least one Commerce Load. - purchaseIntentClickSessions: Unique user sessions containing at least one Purchase Intent Click. - purchaseIntentRateSession: Purchase Intent Click Sessions divided by Commerce Load Sessions. - transactions: Number of attributable, unique orders within the retailer-defined attribution window. - skuSelected: Number of times a product was selected within a Commerce Experience. - onlinePurchaseIntentClicks: Purchase Intent Clicks targeting online stores (e.g., retailer PDPs). - offlinePurchaseIntentClicks: Purchase Intent Clicks targeting physical stores (e.g., store cards). - avgPriceLocalCurrency: Average product price in the product''s local currency (historical pricing). - minPriceLocalCurrency: Minimum product price in the product''s local currency (historical pricing). - maxPriceLocalCurrency: Maximum product price in the product''s local currency (historical pricing). - medianPriceLocalCurrency: Median product price in the product''s local currency (historical pricing). - inStock: Count of in-stock observations for the product at the retailer (historical pricing). - outOfStock: Count of out-of-stock observations for the product at the retailer (historical pricing). - retailerOpportunities: Count of retailer-display opportunities in the window. - missedRetailerOpportunities: Opportunities where no retailer was actually displayed. - retailerImpressions: Count of times a retailer was an option to checkout for a recipe. - retailerDisplayed: Times at least one store of a retailer was visible in an Experience (logo on-screen). - retailerInStock: Times at least one store of a retailer had stock available as a click-through option. - retailerOutOfStock: Times an eligible retailer had only out-of-stock stores in the Experience. - retailerInStockRate: retailerInStock / (retailerInStock + retailerOutOfStock). - retailerDisplayRate: retailerDisplayed / (retailerInStock + retailerOutOfStock). - retailerCTR: purchaseIntentClicks / retailerDisplayed (retailer click-through rate). - transactionValue: Attributed transaction value (shoppable recipes), in the selected currency. - commerceLoadedRate: Commerce-load rate for custom reports (ratio). - shoppableCommerceLoadedRate: Percentage of CTA Views that resulted in a Commerce Load (shoppable). - visitorConversionRate: purchaseIntentClicks / ctaView. - shoppableTransactionConversionRate: transactions / purchaseIntentClicks (shoppable). - shoppableTransactionValueConversionRate: transactionValue / purchaseIntentValue (shoppable).' ObjectIdFilters: additionalProperties: false description: Filter by MongoDB ObjectId strings (24-character hex). properties: includes: description: Include rows where the dimension matches any of these 24-character hex ObjectId strings (IN). items: type: string title: Includes type: array excludes: description: Exclude rows where the dimension matches any of these 24-character hex ObjectId strings (NOT IN). items: type: string title: Excludes type: array title: ObjectIdFilters type: object OrderDirection: type: string enum: - ASC - DESC title: OrderDirection description: 'Sort direction applied to ``sort_by`` in custom reports. Members: - ASC: Ascending (smallest/earliest first). - DESC: Descending (largest/latest first).' ReportAdvancedFiltersResponse: properties: dimensions: items: $ref: '#/components/schemas/AdvancedFilterDimension' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/AdvancedFilterMetric' type: array title: Metrics type: object required: - dimensions - metrics title: ReportAdvancedFiltersResponse description: 'Response for advanced filter component: dimensions and metrics with operators, no filter values.' ReportFields: properties: dimensions: anyOf: - $ref: '#/components/schemas/ListConfig' - type: 'null' metrics: anyOf: - $ref: '#/components/schemas/ListConfig' - type: 'null' type: object title: ReportFields description: Report builder configuration ReportFieldsResponse: properties: data: $ref: '#/components/schemas/ReportFields' type: object required: - data title: ReportFieldsResponse description: Model for holding all the report builder configurations ReportFiltersResponse: properties: filters: additionalProperties: $ref: '#/components/schemas/ListConfig' type: object title: Filters type: object required: - filters title: ReportFiltersResponse ReportPaginatedResponse: properties: total: anyOf: - type: integer - type: 'null' title: Total nextPage: type: boolean title: Nextpage columns: items: $ref: '#/components/schemas/Column' type: array title: Columns data: items: $ref: '#/components/schemas/Row' type: array title: Data type: object required: - nextPage - columns - data title: ReportPaginatedResponse Row: properties: date: type: string format: date title: Date country: anyOf: - type: string - type: 'null' title: Country currency: type: string title: Currency productBrandName: type: string title: Productbrandname experience: type: string title: Experience commerceType: type: string title: Commercetype productName: type: string title: Productname alternateProductName: type: string title: Alternateproductname modelName: type: string title: Modelname retailer: type: string title: Retailer utmSource: type: string title: Utmsource utmMedium: type: string title: Utmmedium utmCampaign: type: string title: Utmcampaign utmTerm: type: string title: Utmterm utmContent: type: string title: Utmcontent utmAdId: type: string title: Utmadid utmPlacement: type: string title: Utmplacement utmBu: type: string title: Utmbu utmClicktype: type: string title: Utmclicktype utmVariant: type: string title: Utmvariant utmAdvertiserId: type: string title: Utmadvertiserid utmPlacementId: type: string title: Utmplacementid utmFormat: type: string title: Utmformat utmCreativeid: type: string title: Utmcreativeid utmConfig: type: string title: Utmconfig utmId: type: string title: Utmid utmMarketingTactic: type: string title: Utmmarketingtactic utmSourcePlatform: type: string title: Utmsourceplatform utmCreativeFormat: type: string title: Utmcreativeformat standardSource: type: string title: Standardsource standardMedium: type: string title: Standardmedium productCategoryName: type: string title: Productcategoryname productLine: type: string title: Productline productRange: type: string title: Productrange productCustomCategory: type: string title: Productcustomcategory productCustomSubcategory1: type: string title: Productcustomsubcategory1 productCustomSubcategory2: type: string title: Productcustomsubcategory2 productCustomSubcategory3: type: string title: Productcustomsubcategory3 productCustomSubcategory4: type: string title: Productcustomsubcategory4 subaccountId: type: string title: Subaccountid ean: type: string title: Ean mpn: type: string title: Mpn partnerId: type: string title: Partnerid recipeName: type: string title: Recipename recipeRetailer: type: string title: Reciperetailer recipeUtmSource: type: string title: Recipeutmsource recipeUtmMedium: type: string title: Recipeutmmedium recipeUtmCampaign: type: string title: Recipeutmcampaign domain: type: string title: Domain pageUrl: type: string title: Pageurl domainUrl: type: string title: Domainurl shopperCity: type: string title: Shoppercity shopperRegion: type: string title: Shopperregion shopperCountry: type: string title: Shoppercountry shopperZipCode: type: string title: Shopperzipcode brandEntity: type: string title: Brandentity isBundle: type: string title: Isbundle deviceType: type: string title: Devicetype purchaseIntentValue: type: number title: Purchaseintentvalue averageClickPrice: anyOf: - type: number - type: 'null' title: Averageclickprice purchaseIntentClicks: type: integer title: Purchaseintentclicks ctaView: type: integer title: Ctaview rawSalesAccountAmount: type: number title: Rawsalesaccountamount rawSalesAmount: type: number title: Rawsalesamount commerceLoads: type: integer title: Commerceloads purchaseIntentRate: anyOf: - type: number - type: 'null' title: Purchaseintentrate ctaViewSessions: type: integer title: Ctaviewsessions commerceLoadSessions: type: integer title: Commerceloadsessions purchaseIntentClickSessions: type: integer title: Purchaseintentclicksessions purchaseIntentRateSession: anyOf: - type: number - type: 'null' title: Purchaseintentratesession transactions: type: integer title: Transactions skuSelected: type: integer title: Skuselected successfulSearches: type: integer title: Successfulsearches unsuccessfulSearches: type: integer title: Unsuccessfulsearches onlinePurchaseIntentClicks: type: integer title: Onlinepurchaseintentclicks offlinePurchaseIntentClicks: type: integer title: Offlinepurchaseintentclicks avgPriceLocalCurrency: anyOf: - type: number - type: 'null' title: Avgpricelocalcurrency minPriceLocalCurrency: anyOf: - type: number - type: 'null' title: Minpricelocalcurrency maxPriceLocalCurrency: anyOf: - type: number - type: 'null' title: Maxpricelocalcurrency medianPriceLocalCurrency: anyOf: - type: number - type: 'null' title: Medianpricelocalcurrency inStock: type: integer title: Instock outOfStock: type: integer title: Outofstock retailerOpportunities: type: integer title: Retaileropportunities missedRetailerOpportunities: type: integer title: Missedretaileropportunities retailerImpressions: type: integer title: Retailerimpressions retailerDisplayed: type: integer title: Retailerdisplayed retailerInStock: type: integer title: Retailerinstock retailerOutOfStock: type: integer title: Retaileroutofstock retailerInStockRate: anyOf: - type: number - type: 'null' title: Retailerinstockrate retailerDisplayRate: anyOf: - type: number - type: 'null' title: Retailerdisplayrate retailerCTR: anyOf: - type: number - type: 'null' title: Retailerctr transactionValue: anyOf: - type: number - type: 'null' title: Transactionvalue commerceLoadedRate: anyOf: - type: number - type: 'null' title: Commerceloadedrate shoppableCommerceLoadedRate: anyOf: - type: number - type: 'null' title: Shoppablecommerceloadedrate visitorConversionRate: anyOf: - type: number - type: 'null' title: Visitorconversionrate shoppableTransactionConversionRate: anyOf: - type: number - type: 'null' title: Shoppabletransactionconversionrate shoppableTransactionValueConversionRate: anyOf: - type: number - type: 'null' title: Shoppabletransactionvalueconversionrate minAuraRoas: anyOf: - type: number - type: 'null' title: Minauraroas maxAuraRoas: anyOf: - type: number - type: 'null' title: Maxauraroas auraAdSpend: anyOf: - type: number - type: 'null' title: Auraadspend auraIncrementalContribution: anyOf: - type: number - type: 'null' title: Auraincrementalcontribution type: object title: Row ShoppableRecipeReportFieldsRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: items: $ref: '#/components/schemas/Dimensions' type: array title: Filters description: Filters are used to filter the data based on the selected dimensions. Only provide the filter labels and not the filter values. accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL maxLength: 3 minLength: 3 title: Currency description: The Currency field is required in the request body to provide the monetary metrics in the adequate currency. type: object required: - dimensions - metrics - filters - accountId - currency title: ShoppableRecipeReportFieldsRequestBody ShoppableRecipeReportFiltersRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: additionalProperties: anyOf: - $ref: '#/components/schemas/IntFilters' - $ref: '#/components/schemas/StrFilters' propertyNames: $ref: '#/components/schemas/Dimensions' type: object title: Filters accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL maxLength: 3 minLength: 3 title: Currency description: The Currency field is required in the request body to provide the monetary metrics in the adequate currency. startDate: type: string format: date title: Startdate endDate: type: string format: date title: Enddate subaccountIds: anyOf: - items: type: string type: array - type: 'null' title: Subaccountids default: [] type: object required: - dimensions - metrics - filters - accountId - currency - startDate - endDate title: ShoppableRecipeReportFiltersRequestBody ShoppableRecipeReportPaginatedRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: additionalProperties: anyOf: - $ref: '#/components/schemas/IntFilters' - $ref: '#/components/schemas/StrFilters' propertyNames: $ref: '#/components/schemas/Dimensions' type: object title: Filters accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL maxLength: 3 minLength: 3 title: Currency description: The Currency field is required in the request body to provide the monetary metrics in the adequate currency. startDate: type: string format: date title: Startdate endDate: type: string format: date title: Enddate subaccountIds: anyOf: - items: type: string type: array - type: 'null' title: Subaccountids default: [] sortBy: type: string enum: - date - country - currency - productBrandName - experience - commerceType - productName - alternateProductName - modelName - retailer - utmSource - utmMedium - utmCampaign - utmTerm - utmContent - utmAdId - utmPlacement - utmBu - utmClicktype - utmVariant - utmAdvertiserId - utmPlacementId - utmFormat - utmCreativeid - utmConfig - utmId - utmMarketingTactic - utmSourcePlatform - utmCreativeFormat - standardSource - standardMedium - productCategoryName - productLine - productRange - productCustomCategory - productCustomSubcategory1 - productCustomSubcategory2 - productCustomSubcategory3 - productCustomSubcategory4 - subaccountId - ean - mpn - partnerId - recipeName - recipeRetailer - recipeUtmSource - recipeUtmMedium - recipeUtmCampaign - domain - pageUrl - domainUrl - shopperCity - shopperRegion - shopperCountry - shopperZipCode - brandEntity - isBundle - deviceType - purchaseIntentValue - averageClickPrice - purchaseIntentClicks - ctaView - rawSalesAccountAmount - rawSalesAmount - commerceLoads - purchaseIntentRate - ctaViewSessions - commerceLoadSessions - purchaseIntentClickSessions - purchaseIntentRateSession - transactions - skuSelected - successfulSearches - unsuccessfulSearches - onlinePurchaseIntentClicks - offlinePurchaseIntentClicks - avgPriceLocalCurrency - minPriceLocalCurrency - maxPriceLocalCurrency - medianPriceLocalCurrency - inStock - outOfStock - retailerOpportunities - missedRetailerOpportunities - retailerImpressions - retailerDisplayed - retailerInStock - retailerOutOfStock - retailerInStockRate - retailerDisplayRate - retailerCTR - transactionValue - commerceLoadedRate - shoppableCommerceLoadedRate - visitorConversionRate - shoppableTransactionConversionRate - shoppableTransactionValueConversionRate - minAuraRoas - maxAuraRoas - auraAdSpend - auraIncrementalContribution title: Sortby sortDir: $ref: '#/components/schemas/OrderDirection' dateFreq: $ref: '#/components/schemas/DateFreq' default: D offset: type: integer minimum: 0 title: Offset count: type: integer maximum: 10000 minimum: 1 title: Count type: object required: - dimensions - metrics - filters - accountId - currency - startDate - endDate - sortBy - sortDir - offset - count title: ShoppableRecipeReportPaginatedRequestBody ShoppableRecipeReportRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: additionalProperties: anyOf: - $ref: '#/components/schemas/IntFilters' - $ref: '#/components/schemas/StrFilters' propertyNames: $ref: '#/components/schemas/Dimensions' type: object title: Filters accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL maxLength: 3 minLength: 3 title: Currency description: The Currency field is required in the request body to provide the monetary metrics in the adequate currency. startDate: type: string format: date title: Startdate endDate: type: string format: date title: Enddate subaccountIds: anyOf: - items: type: string type: array - type: 'null' title: Subaccountids default: [] sortBy: type: string enum: - date - country - currency - productBrandName - experience - commerceType - productName - alternateProductName - modelName - retailer - utmSource - utmMedium - utmCampaign - utmTerm - utmContent - utmAdId - utmPlacement - utmBu - utmClicktype - utmVariant - utmAdvertiserId - utmPlacementId - utmFormat - utmCreativeid - utmConfig - utmId - utmMarketingTactic - utmSourcePlatform - utmCreativeFormat - standardSource - standardMedium - productCategoryName - productLine - productRange - productCustomCategory - productCustomSubcategory1 - productCustomSubcategory2 - productCustomSubcategory3 - productCustomSubcategory4 - subaccountId - ean - mpn - partnerId - recipeName - recipeRetailer - recipeUtmSource - recipeUtmMedium - recipeUtmCampaign - domain - pageUrl - domainUrl - shopperCity - shopperRegion - shopperCountry - shopperZipCode - brandEntity - isBundle - deviceType - purchaseIntentValue - averageClickPrice - purchaseIntentClicks - ctaView - rawSalesAccountAmount - rawSalesAmount - commerceLoads - purchaseIntentRate - ctaViewSessions - commerceLoadSessions - purchaseIntentClickSessions - purchaseIntentRateSession - transactions - skuSelected - successfulSearches - unsuccessfulSearches - onlinePurchaseIntentClicks - offlinePurchaseIntentClicks - avgPriceLocalCurrency - minPriceLocalCurrency - maxPriceLocalCurrency - medianPriceLocalCurrency - inStock - outOfStock - retailerOpportunities - missedRetailerOpportunities - retailerImpressions - retailerDisplayed - retailerInStock - retailerOutOfStock - retailerInStockRate - retailerDisplayRate - retailerCTR - transactionValue - commerceLoadedRate - shoppableCommerceLoadedRate - visitorConversionRate - shoppableTransactionConversionRate - shoppableTransactionValueConversionRate - minAuraRoas - maxAuraRoas - auraAdSpend - auraIncrementalContribution title: Sortby sortDir: $ref: '#/components/schemas/OrderDirection' dateFreq: $ref: '#/components/schemas/DateFreq' default: D type: object required: - dimensions - metrics - filters - accountId - currency - startDate - endDate - sortBy - sortDir title: ShoppableRecipeReportRequestBody ShoppableRecipeReportSummaryRequestBody: properties: dimensions: items: $ref: '#/components/schemas/Dimensions' type: array title: Dimensions metrics: items: $ref: '#/components/schemas/Metrics' type: array title: Metrics filters: additionalProperties: anyOf: - $ref: '#/components/schemas/IntFilters' - $ref: '#/components/schemas/StrFilters' propertyNames: $ref: '#/components/schemas/Dimensions' type: object title: Filters accountId: type: string title: Accountid description: If accountId is not provided, the accountId will be taken from the token. currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL maxLength: 3 minLength: 3 title: Currency description: The Currency field is required in the request body to provide the monetary metrics in the adequate currency. startDate: type: string format: date title: Startdate endDate: type: string format: date title: Enddate subaccountIds: anyOf: - items: type: string type: array - type: 'null' title: Subaccountids default: [] dateFreq: $ref: '#/components/schemas/DateFreq' default: D type: object required: - dimensions - metrics - filters - accountId - currency - startDate - endDate title: ShoppableRecipeReportSummaryRequestBody StrFilters: additionalProperties: false properties: includes: description: Include rows where value is in this list (IN). items: type: string title: Includes type: array excludes: description: Exclude rows where value is in this list (NOT IN). items: type: string title: Excludes type: array contains: description: Include rows where value contains any of these strings (case-insensitive LIKE %...%). Combined with OR. Max 5 values. items: type: string maxItems: 5 title: Contains type: array notContains: description: Exclude rows where value contains any of these strings (case-insensitive NOT LIKE %...%). Combined with AND. Max 5 values. items: type: string maxItems: 5 title: Notcontains type: array title: StrFilters type: object Summary: properties: date: $ref: '#/components/schemas/SummaryItem' country: $ref: '#/components/schemas/SummaryItem' currency: $ref: '#/components/schemas/SummaryItem' productBrandName: $ref: '#/components/schemas/SummaryItem' experience: $ref: '#/components/schemas/SummaryItem' commerceType: $ref: '#/components/schemas/SummaryItem' productName: $ref: '#/components/schemas/SummaryItem' alternateProductName: $ref: '#/components/schemas/SummaryItem' modelName: $ref: '#/components/schemas/SummaryItem' retailer: $ref: '#/components/schemas/SummaryItem' utmSource: $ref: '#/components/schemas/SummaryItem' utmMedium: $ref: '#/components/schemas/SummaryItem' utmCampaign: $ref: '#/components/schemas/SummaryItem' utmTerm: $ref: '#/components/schemas/SummaryItem' utmContent: $ref: '#/components/schemas/SummaryItem' utmAdId: $ref: '#/components/schemas/SummaryItem' utmPlacement: $ref: '#/components/schemas/SummaryItem' utmBu: $ref: '#/components/schemas/SummaryItem' utmClicktype: $ref: '#/components/schemas/SummaryItem' utmVariant: $ref: '#/components/schemas/SummaryItem' utmAdvertiserId: $ref: '#/components/schemas/SummaryItem' utmPlacementId: $ref: '#/components/schemas/SummaryItem' utmFormat: $ref: '#/components/schemas/SummaryItem' utmCreativeid: $ref: '#/components/schemas/SummaryItem' utmConfig: $ref: '#/components/schemas/SummaryItem' utmId: $ref: '#/components/schemas/SummaryItem' utmMarketingTactic: $ref: '#/components/schemas/SummaryItem' utmSourcePlatform: $ref: '#/components/schemas/SummaryItem' utmCreativeFormat: $ref: '#/components/schemas/SummaryItem' standardSource: $ref: '#/components/schemas/SummaryItem' standardMedium: $ref: '#/components/schemas/SummaryItem' productCategoryName: $ref: '#/components/schemas/SummaryItem' productLine: $ref: '#/components/schemas/SummaryItem' productRange: $ref: '#/components/schemas/SummaryItem' productCustomCategory: $ref: '#/components/schemas/SummaryItem' productCustomSubcategory1: $ref: '#/components/schemas/SummaryItem' productCustomSubcategory2: $ref: '#/components/schemas/SummaryItem' productCustomSubcategory3: $ref: '#/components/schemas/SummaryItem' productCustomSubcategory4: $ref: '#/components/schemas/SummaryItem' subaccountId: $ref: '#/components/schemas/SummaryItem' ean: $ref: '#/components/schemas/SummaryItem' mpn: $ref: '#/components/schemas/SummaryItem' partnerId: $ref: '#/components/schemas/SummaryItem' recipeName: $ref: '#/components/schemas/SummaryItem' recipeRetailer: $ref: '#/components/schemas/SummaryItem' recipeUtmSource: $ref: '#/components/schemas/SummaryItem' recipeUtmMedium: $ref: '#/components/schemas/SummaryItem' recipeUtmCampaign: $ref: '#/components/schemas/SummaryItem' domain: $ref: '#/components/schemas/SummaryItem' pageUrl: $ref: '#/components/schemas/SummaryItem' domainUrl: $ref: '#/components/schemas/SummaryItem' shopperCity: $ref: '#/components/schemas/SummaryItem' shopperRegion: $ref: '#/components/schemas/SummaryItem' shopperCountry: $ref: '#/components/schemas/SummaryItem' shopperZipCode: $ref: '#/components/schemas/SummaryItem' brandEntity: $ref: '#/components/schemas/SummaryItem' isBundle: $ref: '#/components/schemas/SummaryItem' deviceType: $ref: '#/components/schemas/SummaryItem' purchaseIntentValue: $ref: '#/components/schemas/SummaryItem' averageClickPrice: $ref: '#/components/schemas/SummaryItem' purchaseIntentClicks: $ref: '#/components/schemas/SummaryItem' ctaView: $ref: '#/components/schemas/SummaryItem' rawSalesAccountAmount: $ref: '#/components/schemas/SummaryItem' rawSalesAmount: $ref: '#/components/schemas/SummaryItem' commerceLoads: $ref: '#/components/schemas/SummaryItem' purchaseIntentRate: $ref: '#/components/schemas/SummaryItem' ctaViewSessions: $ref: '#/components/schemas/SummaryItem' commerceLoadSessions: $ref: '#/components/schemas/SummaryItem' purchaseIntentClickSessions: $ref: '#/components/schemas/SummaryItem' purchaseIntentRateSession: $ref: '#/components/schemas/SummaryItem' transactions: $ref: '#/components/schemas/SummaryItem' skuSelected: $ref: '#/components/schemas/SummaryItem' successfulSearches: $ref: '#/components/schemas/SummaryItem' unsuccessfulSearches: $ref: '#/components/schemas/SummaryItem' onlinePurchaseIntentClicks: $ref: '#/components/schemas/SummaryItem' offlinePurchaseIntentClicks: $ref: '#/components/schemas/SummaryItem' avgPriceLocalCurrency: $ref: '#/components/schemas/SummaryItem' minPriceLocalCurrency: $ref: '#/components/schemas/SummaryItem' maxPriceLocalCurrency: $ref: '#/components/schemas/SummaryItem' medianPriceLocalCurrency: $ref: '#/components/schemas/SummaryItem' inStock: $ref: '#/components/schemas/SummaryItem' outOfStock: $ref: '#/components/schemas/SummaryItem' retailerOpportunities: $ref: '#/components/schemas/SummaryItem' missedRetailerOpportunities: $ref: '#/components/schemas/SummaryItem' retailerImpressions: $ref: '#/components/schemas/SummaryItem' retailerDisplayed: $ref: '#/components/schemas/SummaryItem' retailerInStock: $ref: '#/components/schemas/SummaryItem' retailerOutOfStock: $ref: '#/components/schemas/SummaryItem' retailerInStockRate: $ref: '#/components/schemas/SummaryItem' retailerDisplayRate: $ref: '#/components/schemas/SummaryItem' retailerCTR: $ref: '#/components/schemas/SummaryItem' transactionValue: $ref: '#/components/schemas/SummaryItem' commerceLoadedRate: $ref: '#/components/schemas/SummaryItem' shoppableCommerceLoadedRate: $ref: '#/components/schemas/SummaryItem' visitorConversionRate: $ref: '#/components/schemas/SummaryItem' shoppableTransactionConversionRate: $ref: '#/components/schemas/SummaryItem' shoppableTransactionValueConversionRate: $ref: '#/components/schemas/SummaryItem' minAuraRoas: $ref: '#/components/schemas/SummaryItem' maxAuraRoas: $ref: '#/components/schemas/SummaryItem' auraAdSpend: $ref: '#/components/schemas/SummaryItem' auraIncrementalContribution: $ref: '#/components/schemas/SummaryItem' type: object title: Summary SummaryItem: properties: value: anyOf: - type: string - type: integer - type: number - type: 'null' title: Value type: $ref: '#/components/schemas/ColumnType' displayName: type: string title: Displayname description: Human-readable label for this summary cell; follows the same availability suffix rules as Column.displayName when the report starts before the field startDate (see custom_report_fields). type: object required: - type - displayName title: SummaryItem SummaryResponse: properties: data: $ref: '#/components/schemas/Summary' type: object required: - data title: SummaryResponse ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError paths: /reporting/authenticate: post: tags: - Authentication summary: Authenticate user and get access token requestBody: required: true content: application/json: schema: type: object properties: client_id: type: string description: The client ID for authentication. client_secret: type: string description: The client secret for authentication. required: - client_id - client_secret responses: '200': description: Successful authentication content: application/json: schema: type: object properties: access_token: type: string description: The JWT access token. expires_in: type: integer description: Expiration time in seconds. token_type: type: string description: The token type (e.g., Bearer). expires_at: type: string format: date-time description: The timestamp when the token expires. '400': description: Invalid client credentials '500': description: Internal server error /reporting/v1/custom_report_fields: post: tags: - Custom Reports summary: Retrieve dimensions and metrics description: Returns eligible dimensions and metrics for the current selection. Which dimensions are eligible also depends on metric compatibility rules (e.g. Commerce Loads excludes many catalog and shopper dimensions that remain available with Purchase Intent Clicks alone). Set fieldDetails to 'yes' to include tooltip and category on each dimension and metric value; omit fieldDetails for a lighter response (label, code, and startDate when configured). When fieldDetails is 'yes', pass startDate to conditionally append metric/dimension availability warnings in tooltips (only when the range starts before the field's startDate). operationId: custom_report_fields_reporting_v1_custom_report_fields_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomReportFieldsRequestBody' examples: report_fields_success: summary: Get Report Fields Success Example description: 'Retrieve a list of eligible dimensions and metrics to run a report. ' value: currency: USD fieldDetails: 'yes' metrics: - purchaseIntentClicks dimensions: - country filters: - commerceType - retailer report_fields_failure: summary: Get Report Fields Failure Example description: 'Retrieve a list of eligible dimensions and metrics to run a report. ' value: currency: USD metrics: - ctaView - purchaseIntentClicks dimensions: - country filters: - commerceType - retailer required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportFieldsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: [] /reporting/v1/custom_report_filters: post: tags: - Custom Reports summary: Retrieve filters description: This endpoint retrieves filters and valid filter values based on selected date range, dimensions, metrics and filters. The same rules as custom_report apply for choosing the backend data source from row dimensions, metrics, and dimension keys in the filters map; incompatible combinations return 422. The response includes base filter dimensions only. operationId: custom_report_filters_reporting_v1_custom_report_filters_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomReportFacetsRequestBody' examples: country: summary: Get Filters Example description: Retrieve a list of filters available for generating country-specific reports for January 2025, focusing on CTA View, Commerce Load, and Purchase Intent Click metrics. The returned filters are specifically limited to those related to Brand.com experiences, allowing for targeted and relevant report customization value: startDate: '2025-01-01' endDate: '2025-01-31' metrics: - ctaView - commerceLoads - purchaseIntentClicks dimensions: - country filters: commerceType: includes: - ST currency: USD required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportFiltersResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: [] /reporting/v1/custom_report_advanced_filters: post: tags: - Custom Reports summary: Retrieve advanced filter metadata description: 'This endpoint is called when the UI initializes the advanced filter component for the Custom Report Builder. It returns dimension and metric metadata (name, displayName, operators, dataType) without filter values. Each operators item has code (same keys as the custom_report filters map: includes, excludes, contains, notContains for dimensions; isHigherThan, isLowerThan for metrics) and label (UI text). It does not require a filters section in the request body. The date dimension is not returned. Coded dimensions (e.g. commerceExperience, country, commerceType, standardSource, standardMedium, utmMarketingTactic) expose only includes and excludes. Product category name, product line, and product range use equality-style filtering in the data source and also expose only includes and excludes (not contains / does not contain). utmSource, utmMedium, and other non-coded dimensions expose all four dimension operators. If any requested metric is invalid or unavailable, the metrics array in the response is empty.' operationId: custom_report_advanced_filters_reporting_v1_custom_report_advanced_filters_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomReportAdvancedFiltersRequestBody' examples: advanced_filters: summary: Get advanced filters example description: Initialize advanced filter component with dimensions and metrics; no filters section required. value: metrics: - ctaView - commerceLoads - purchaseIntentClicks dimensions: - country currency: USD required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportAdvancedFiltersResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: [] /reporting/v1/custom_report_single_filter: post: tags: - Custom Reports summary: Retrieve filter values for a single dimension description: Returns all possible filter values for a single dimension across a date range. Uses the same response structure as the custom_report_filters endpoint (a `filters` object with one dimension). By design, this endpoint ignores other filters and does not guarantee a non-empty intersection; it is intended for the Advanced Filter component when using Is or Is Not operators. Lighter and more scalable than the full custom_report_filters endpoint. operationId: custom_report_single_filter_reporting_v1_custom_report_single_filter_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomReportSingleFilterRequestBody' examples: country: summary: Get single filter (country) example description: Retrieve all country filter values for the account in January 2025. value: startDate: '2025-01-01' endDate: '2025-01-31' filter: country required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportFiltersResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: [] /reporting/v1/custom_report: post: tags: - Custom Reports summary: Retrieve custom report description: This endpoint retrieves a custom report based on selected date range, dimensions, metrics and filters. The report is paginated and must be passed a count and offset. The maximum number of records that can be returned on one page is 5000. The report is sorted by the provided sortBy and sortDir parameters. **Backend data source:** the backend selects a dataset that supports all row dimensions, all metrics, and every dimension key present in the filters map (including advanced filters); if no single dataset can satisfy that combination, the API returns 422. **Filters map:** most string dimensions support includes, excludes, contains, and notContains. Product category name, product line, and product range support only includes and excludes (requests with contains or notContains on those dimensions return 422). Metric keys may use isHigherThan (inclusive lower bound, SQL >=) and/or isLowerThan (inclusive upper bound, SQL <=); these apply **after aggregation** (HAVING). Numeric bounds are truncated to six decimal places; at most one metric per request may use numeric filters. Advanced-only dimensions (e.g. utmPlacement) in the filters map require useAdvancedFilters=true, same as for custom_report_fields. operationId: custom_report_reporting_v1_custom_report_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomReportPaginatedRequestBody' examples: country: summary: Get Filters Example description: Runs a by country by date report for January 2025, focusing on CTA View, Commerce Load, and Purchase Intent Click metrics. The report is sorted by CTA View in descending order and paginated to return the first 5000 records. The report is filtered to only include data from the Brand.com (ST) commerce type. value: startDate: '2025-01-01' endDate: '2025-01-31' metrics: - ctaView - commerceLoads - purchaseIntentClicks dimensions: - date - country filters: commerceType: includes: - ST currency: USD sortBy: ctaView sortDir: DESC dateFreq: D offset: 0 count: 5000 filters_join_or: summary: Filters combined with OR description: 'Same as country example but with filtersJoinOperator OR: top-level filter conditions are combined with OR instead of AND.' metric_numeric_filter: summary: Metric numeric filter (HAVING) description: Same as country example, plus a post-aggregation lower bound on commerceLoads (>= 100). value: startDate: '2025-01-01' endDate: '2025-01-31' metrics: - ctaView - commerceLoads - purchaseIntentClicks dimensions: - date - country filtersJoinOperator: OR filters: commerceType: includes: - ST country: includes: - US commerceLoads: isHigherThan: 100 currency: USD sortBy: ctaView sortDir: DESC dateFreq: D offset: 0 count: 5000 required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportPaginatedResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: [] /reporting/v1/custom_report/export: post: tags: - Custom Reports summary: Export custom report description: This endpoint exports a custom report based on selected date range, dimensions, metrics and filters. The report is sorted by the provided sortBy and sortDir parameters. Accepts the same filters map as custom_report (including optional metric isHigherThan / isLowerThan bounds) and the same backend table selection; incompatible combinations return 422. operationId: custom_report_export_reporting_v1_custom_report_export_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomReportRequestBody' examples: example: summary: Export Report Example description: Exports a by country by date report for January 2025, focusing on CTA View, Commerce Load, and Purchase Intent Click metrics. The report is sorted by CTA View in descending order and is filtered to only include data from the Brand.com (ST) commerce type. value: startDate: '2025-01-01' endDate: '2025-01-31' metrics: - ctaView - commerceLoads - purchaseIntentClicks dimensions: - date - country filters: commerceType: includes: - ST currency: USD sortBy: ctaView sortDir: DESC dateFreq: D required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ExportResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: [] /reporting/v1/pricing_intelligence_report_fields: post: tags: - Historical Pricing Reports summary: Retrieve dimensions and metrics description: This endpoint retrieves valid dimensions and metrics based on selected dimensions, metrics and filters. operationId: pricing_intelligence_report_fields_reporting_v1_pricing_intelligence_report_fields_post requestBody: content: application/json: schema: $ref: '#/components/schemas/HistoricalPricingReportFieldsRequestBody' examples: report_fields_success: summary: Get Report Fields Example description: 'Retrieve a list of eligible dimensions and metrics to run a report. ' value: metrics: - avgPriceLocalCurrency - inStock dimensions: - country - currency filters: country: includes: - US required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportFieldsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: [] /reporting/v1/pricing_intelligence_filters: post: tags: - Historical Pricing Reports summary: Retrieve filters description: This endpoint retrieves filters and valid filter values based on selected date range, dimensions, metrics and filters. operationId: pricing_intelligence_filters_reporting_v1_pricing_intelligence_filters_post requestBody: content: application/json: schema: $ref: '#/components/schemas/HistoricalPricingReportFiltersRequestBody' examples: country: summary: Get Filters Example description: Retrieve a list of filters available for generating country-specific reports for January 2025, focusing on Price and In-Stock metrics. The returned filters are specifically limited to those related to the US. value: startDate: '2025-01-01' endDate: '2025-01-31' metrics: - avgPriceLocalCurrency - inStock dimensions: - country - currency filters: country: includes: - US required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportFiltersResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: [] /reporting/v1/pricing_intelligence: post: tags: - Historical Pricing Reports summary: Retrieve custom report description: This endpoint retrieves a historical pricing report based on selected date range, dimensions, metrics and filters. The report is paginated and must be passed a count and offset. The maximum number of records that can be returned on one page is 5000. The report is sorted by the provided sortBy and sortDir parameters. operationId: pricing_intelligence_reporting_v1_pricing_intelligence_post requestBody: content: application/json: schema: $ref: '#/components/schemas/HistoricalPricingReportPaginatedRequestBody' examples: country: summary: Get Report Example description: Runs a historical pricing report by date for January 2025, focusing on Price and In-Stock metrics. The report is sorted by date in descending order and paginated to return the first 5000 records. The report is filtered to only include relevent data from the US. value: startDate: '2025-01-01' endDate: '2025-01-31' metrics: - avgPriceLocalCurrency - inStock dimensions: - date - country - currency filters: country: includes: - US sortBy: date sortDir: DESC offset: 0 count: 5000 required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportPaginatedResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: [] /reporting/v1/pricing_intelligence/export: post: tags: - Historical Pricing Reports summary: Export custom report description: This endpoint retrieves a historical pricing report based on selected date range, dimensions, metrics and filters. The report is paginated and must be passed a count and offset. The report is sorted by the provided sortBy and sortDir parameters. operationId: pricing_intelligence_export_reporting_v1_pricing_intelligence_export_post requestBody: content: application/json: schema: $ref: '#/components/schemas/HistoricalPricingReportRequestBody' examples: country: summary: Get Report Example description: Runs a historical pricing report by date for January 2025, focusing on Price and In-Stock metrics. The report is sorted by date in descending order and is filtered to only include relevent data from the US. value: startDate: '2025-01-01' endDate: '2025-01-31' metrics: - avgPriceLocalCurrency - inStock dimensions: - date - country - currency filters: country: includes: - US sortBy: date sortDir: DESC required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ExportResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: [] /reporting/v1/shoppable_recipe_report_fields: post: tags: - Shoppable Recipe Reports summary: Retrieve dimensions and metrics description: This endpoint retrieves valid dimensions and metrics based on selected dimensions, metrics and filters. operationId: shoppable_recipe_report_fields_reporting_v1_shoppable_recipe_report_fields_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ShoppableRecipeReportFieldsRequestBody' examples: example: summary: Get Report Fields Success Example description: 'Retrieve a list of eligible dimensions and metrics to run a report. ' value: metrics: - purchaseIntentClicks dimensions: - date - partnerId filters: - recipeName - recipeRetailer currency: USD required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportFieldsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: [] /reporting/v1/shoppable_recipe_report_filters: post: tags: - Shoppable Recipe Reports summary: Retrieve filters description: This endpoint retrieves filters and valid filter values based on selected date range, dimensions, metrics and filters. operationId: shoppable_recipe_report_filters_reporting_v1_shoppable_recipe_report_filters_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ShoppableRecipeReportFiltersRequestBody' examples: example: summary: Get Filters Example description: Retrieve a list of filters available for generating country-specific reports for January 2025, focusing on CTA View, Commerce Load, and Purchase Intent Click metrics. The returned filters are specifically limited to those related to Brand.com experiences, allowing for targeted and relevant report customization value: startDate: '2025-01-01' endDate: '2025-01-31' metrics: - ctaView - commerceLoads - purchaseIntentClicks dimensions: - date - partnerId filters: partnerId: includes: - abc123 currency: USD required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportFiltersResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: [] /reporting/v1/shoppable_recipe_report: post: tags: - Shoppable Recipe Reports summary: Retrieve custom report description: This endpoint retrieves a custom report based on selected date range, dimensions, metrics and filters. The report is paginated and must be passed a count and offset. The maximum number of records that can be returned on one page is 5000. The report is sorted by the provided sortBy and sortDir parameters. operationId: shoppable_recipe_report_reporting_v1_shoppable_recipe_report_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ShoppableRecipeReportPaginatedRequestBody' examples: example: summary: Get Filters Example description: Runs a by country by date report for January 2025, focusing on CTA View, Commerce Loads and Purchase Intent Clicks metrics. The report is sorted by CTA View in descending order and paginated to return the first 5000 records. The report is filtered to only include data from the partnerId '123' and the recipeName 'Best Recipe Ever'. value: startDate: '2025-01-01' endDate: '2025-01-31' metrics: - ctaView - commerceLoads - purchaseIntentClicks dimensions: - date - partnerId - recipeName - domain - recipeUtmSource filters: partnerId: includes: - '123' recipeName: includes: - Best Recipe Ever currency: USD sortBy: ctaView sortDir: DESC dateFreq: D offset: 0 count: 5000 required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportPaginatedResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: [] /reporting/v1/shoppable_recipe_report/export: post: tags: - Shoppable Recipe Reports summary: Export custom report description: This endpoint retrieves a custom report based on selected date range, dimensions, metrics and filters. The report is sorted by the provided sortBy and sortDir parameters. operationId: shoppable_recipe_export_reporting_v1_shoppable_recipe_report_export_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ShoppableRecipeReportRequestBody' examples: example: summary: Get Report Example description: Exports a report by date for January 2025, focusing on Commerce Loads and Purchase Intent Clicks metrics. The report is sorted by domain in ascending order and is filtered to only include data from the partnerId '123' and the recipeName 'Best Recipe Ever'. value: startDate: '2025-01-01' endDate: '2025-01-31' metrics: - commerceLoads - purchaseIntentClicks dimensions: - date - partnerId - recipeName - domain - recipeUtmSource filters: partnerId: includes: - '123' recipeName: includes: - Best Recipe Ever sortBy: domain sortDir: ASC currency: USD required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ExportResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - authorization: [] - x-api-key: []