MikMak

MikMak Historical Pricing Reports API

The Historical Pricing Reports API from MikMak — 4 operation(s) for historical pricing reports.

GitHub OpenAPI

Operations 4

POST /reporting/v1/pricing_intelligence_report_fields Retrieve dimensions and metrics #
POST /reporting/v1/pricing_intelligence_filters Retrieve filters #
POST /reporting/v1/pricing_intelligence Retrieve custom report #
POST /reporting/v1/pricing_intelligence/export Export custom report #

Documentation

📖
Documentation
https://docs.mikmak.ai/reference/mikmak-headless-commerce-api
📖
APIReference
https://docs.mikmak.ai/reference/mikmak-headless-commerce-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/mikmak/refs/heads/main/authentication/mikmak-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/mikmak/refs/heads/main/rate-limits/mikmak-rate-limits.yml
📖
Documentation
https://docs.mikmak.ai/reference/mikmak-insights-api
📖
APIReference
https://api.mikmak.ai/reporting/docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mikmak/refs/heads/main/openapi/mikmak-historical-pricing-reports-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/mikmak/refs/heads/main/scopes/mikmak-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/mikmak/refs/heads/main/errors/mikmak-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/mikmak/refs/heads/main/data-model/mikmak-data-model.yml
🔗
Help Center
https://help.mikmak.ai/hc

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mikmak-historical-pricing-reports-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mikmak-historical-pricing-reports-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: MikMak Insights Historical Pricing Reports 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
servers:
- url: https://api.mikmak.ai
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Historical Pricing Reports
paths:
  /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: []
components:
  schemas:
    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
    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.'
    ReportFieldsResponse:
      properties:
        data:
          $ref: '#/components/schemas/ReportFields'
      type: object
      required:
      - data
      title: ReportFieldsResponse
      description: Model for holding all the report builder configurations
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    ReportFiltersResponse:
      properties:
        filters:
          additionalProperties:
            $ref: '#/components/schemas/ListConfig'
          type: object
          title: Filters
      type: object
      required:
      - filters
      title: ReportFiltersResponse
    ExportResponse:
      properties:
        url:
          type: string
          title: Url
      type: object
      required:
      - url
      title: ExportResponse
    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
    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).'
    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.'
    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).'
    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
    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
    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
    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
    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
    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:
          t

# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mikmak/refs/heads/main/openapi/mikmak-historical-pricing-reports-api-openapi.yml