> ## Documentation Index
> Fetch the complete documentation index at: https://docs.semicola.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Reporting summary / timeseries / CSV



## OpenAPI

````yaml /openapi/buyer.yaml get /api/v2/buyer/reporting/metrics
openapi: 3.1.0
info:
  title: Semicola Exchange buyer API
  version: 2.0.0
  description: >-
    Buyer endpoints: advertisers, storefronts and connections, product
    discovery, campaigns, proposals, media buys, creatives and reporting. Every
    write accepts an Idempotency-Key header.
servers:
  - url: https://api.semicola.com
security:
  - bearerAuth: []
  - sessionCookie: []
tags:
  - name: Advertisers
  - name: Storefronts
  - name: Product Discovery
  - name: Campaigns
  - name: Media Buys
  - name: Creatives
  - name: Reporting
  - name: Event Sources
  - name: Webhooks
  - name: Tasks
  - name: Audit Logs
paths:
  /api/v2/buyer/reporting/metrics:
    get:
      tags:
        - Reporting
      summary: Reporting summary / timeseries / CSV
      operationId: getBuyerReportingMetrics
      parameters:
        - name: advertiserId
          in: query
          required: false
          schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 9007199254740991
        - name: campaignId
          in: query
          required: false
          schema:
            type: string
        - name: mediaBuyId
          in: query
          required: false
          schema:
            type: string
        - name: startDate
          in: query
          required: false
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        - name: endDate
          in: query
          required: false
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        - name: days
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 365
        - name: view
          in: query
          required: false
          schema:
            default: summary
            type: string
            enum:
              - summary
              - timeseries
        - name: download
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: string
                enum:
                  - '0'
                  - '1'
                  - 'true'
                  - 'false'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    anyOf:
                      - oneOf:
                          - type: object
                            properties:
                              view:
                                type: string
                                const: summary
                              periodStart:
                                type: string
                                pattern: ^\d{4}-\d{2}-\d{2}$
                              periodEnd:
                                type: string
                                pattern: ^\d{4}-\d{2}-\d{2}$
                              totalsCurrency:
                                anyOf:
                                  - type: string
                                    pattern: ^[A-Z]{3}$
                                  - type: 'null'
                              totals:
                                type: object
                                propertyNames:
                                  type: string
                                additionalProperties:
                                  type:
                                    - number
                                    - 'null'
                              advertisers:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    advertiserId:
                                      type: integer
                                      exclusiveMinimum: 0
                                      maximum: 9007199254740991
                                    name:
                                      type: string
                                    metrics:
                                      type: object
                                      propertyNames:
                                        type: string
                                      additionalProperties:
                                        type:
                                          - number
                                          - 'null'
                                    currency:
                                      anyOf:
                                        - type: string
                                          pattern: ^[A-Z]{3}$
                                        - type: 'null'
                                    campaigns:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          campaignId:
                                            type: string
                                          name:
                                            type: string
                                          status:
                                            type: string
                                            enum:
                                              - DRAFT
                                              - ACTIVE
                                              - PAUSED
                                              - COMPLETED
                                              - CANCELED
                                              - ARCHIVED
                                          metrics:
                                            type: object
                                            propertyNames:
                                              type: string
                                            additionalProperties:
                                              type:
                                                - number
                                                - 'null'
                                          mediaBuys:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                mediaBuyId:
                                                  type: string
                                                name:
                                                  type: string
                                                sellerName:
                                                  type: string
                                                status:
                                                  type: string
                                                metrics:
                                                  type: object
                                                  propertyNames:
                                                    type: string
                                                  additionalProperties:
                                                    type:
                                                      - number
                                                      - 'null'
                                                packages:
                                                  type: array
                                                  items:
                                                    type: object
                                                    properties:
                                                      packageId:
                                                        type: string
                                                      productName:
                                                        type: string
                                                      metrics:
                                                        type: object
                                                        propertyNames:
                                                          type: string
                                                        additionalProperties:
                                                          type:
                                                            - number
                                                            - 'null'
                                                    required:
                                                      - packageId
                                                      - productName
                                                      - metrics
                                                    additionalProperties: false
                                              required:
                                                - mediaBuyId
                                                - name
                                                - sellerName
                                                - status
                                                - metrics
                                                - packages
                                              additionalProperties: false
                                        required:
                                          - campaignId
                                          - name
                                          - metrics
                                        additionalProperties: false
                                  required:
                                    - advertiserId
                                    - name
                                    - metrics
                                    - campaigns
                                  additionalProperties: false
                            required:
                              - view
                              - periodStart
                              - periodEnd
                              - totalsCurrency
                              - totals
                              - advertisers
                            additionalProperties: false
                          - type: object
                            properties:
                              view:
                                type: string
                                const: timeseries
                              rows:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    date:
                                      type: string
                                      pattern: ^\d{4}-\d{2}-\d{2}$
                                    advertiserId:
                                      type: integer
                                      exclusiveMinimum: 0
                                      maximum: 9007199254740991
                                    campaignId:
                                      type: string
                                    mediaBuyId:
                                      type:
                                        - string
                                        - 'null'
                                    packageId:
                                      type:
                                        - string
                                        - 'null'
                                    metrics:
                                      type: object
                                      propertyNames:
                                        type: string
                                      additionalProperties:
                                        type:
                                          - number
                                          - 'null'
                                  required:
                                    - date
                                    - advertiserId
                                    - campaignId
                                    - mediaBuyId
                                    - packageId
                                    - metrics
                                  additionalProperties: false
                            required:
                              - view
                              - rows
                            additionalProperties: false
                          - type: object
                            properties:
                              view:
                                type: string
                                const: download
                              downloadUrl:
                                type: string
                              expiresAt:
                                type: string
                                format: date-time
                                pattern: >-
                                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                              fileName:
                                type: string
                              rowCount:
                                type: integer
                                minimum: 0
                                maximum: 9007199254740991
                            required:
                              - view
                              - downloadUrl
                              - expiresAt
                              - fileName
                              - rowCount
                            additionalProperties: false
                      - type: 'null'
                  error:
                    anyOf:
                      - type: object
                        properties:
                          code:
                            type: string
                          message:
                            type: string
                          field:
                            type: string
                          details: {}
                        required:
                          - code
                          - message
                        additionalProperties: false
                      - type: 'null'
                required:
                  - data
                  - error
                additionalProperties: false
        default:
          description: >-
            Error envelope `{data: null, error: {code, message, field?,
            details?}}`.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or OAuth access token.
    sessionCookie:
      type: apiKey
      in: cookie
      name: sc_session

````