openapi: 3.2.0
info:
  title: Rubicon Project Reports API
  version: '1.0'
  description: 'Operations tagged Reports across 2 of this provider''s published API definitions: rubicon-project-springserve-v0-openapi.yml, rubicon-project-springserve-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://console.springserve.com/api/v0
  description: SpringServe console. Added by API Evangelist from the published documentation (springserve.atlassian.net/wiki/spaces/SSD/pages/1573617663/API+-+Getting+Started, "Base Url https://console.springserve.com/"); the document Magnite serves declares no servers[] block because the Swagger UI infers the host from window.location.
- url: https://console.clearline.magnite.com/api/v0
  description: ClearLine console. The identical contract is served from ClearLine's own host; base URL published at springserve.atlassian.net/wiki/spaces/CLD/pages/3649929217/Clearline+API+SDK.
- url: https://console.springserve.com/api/v1
  description: SpringServe console. Added by API Evangelist from the published documentation (springserve.atlassian.net/wiki/spaces/SSD/pages/1573617663/API+-+Getting+Started, "Base Url https://console.springserve.com/"); the document Magnite serves declares no servers[] block because the Swagger UI infers the host from window.location.
- url: https://console.clearline.magnite.com/api/v1
  description: ClearLine console. The identical contract is served from ClearLine's own host; base URL published at springserve.atlassian.net/wiki/spaces/CLD/pages/3649929217/Clearline+API+SDK.
security:
- api_key: []
- bearer_token: []
tags:
- name: Reports
paths:
  /api/v0/reports:
    post:
      summary: Create Report
      description: 'Create a report. For Reach & Frequency reports (ClearLine), include interval, timezone, cadences, and async

        exactly as shown. Reports may return QUEUED or BUILDING status; repeat the POST until status is COMPLETE.

        Available for ClearLine account types.

        '
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              simple:
                $ref: '#/components/examples/report_create_simple'
              full:
                $ref: '#/components/examples/report_create_full'
      responses:
        '200':
          description: Report result. Status may be QUEUED, BUILDING, or COMPLETE.
          content:
            application/json:
              schema:
                type: object
              example:
                status: COMPLETE
                report_id: '[36-digit report ID]'
                page: 1
                total_pages: 1
                total_rows: 1
                data:
                - total_impressions: 3785905
                  unique_cookies: 3817644
                  cookie_reach: 0.99
                  cost: 66048.81
                  cpm: 17.45
      tags:
      - Reports
      operationId: reports_post
    servers:
    - url: https://console.springserve.com/api/v0
      description: SpringServe console. Added by API Evangelist from the published documentation (springserve.atlassian.net/wiki/spaces/SSD/pages/1573617663/API+-+Getting+Started, "Base Url https://console.springserve.com/"); the document Magnite serves declares no servers[] block because the Swagger UI infers the host from window.location.
    - url: https://console.clearline.magnite.com/api/v0
      description: ClearLine console. The identical contract is served from ClearLine's own host; base URL published at springserve.atlassian.net/wiki/spaces/CLD/pages/3649929217/Clearline+API+SDK.
  /api/v1/reports:
    post:
      summary: Create
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: ./ref/reports.yaml#/components/schemas/reportParameters
              - type: object
                properties:
                  async:
                    type: boolean
                  csv:
                    type: boolean
                  sort:
                    type: array
                    items:
                      type: string
            examples:
              simple:
                $ref: '#/components/examples/report_create_simple'
              full:
                $ref: '#/components/examples/report_create_full_2'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Reports
      operationId: reports_post
    servers:
    - url: https://console.springserve.com/api/v1
      description: SpringServe console. Added by API Evangelist from the published documentation (springserve.atlassian.net/wiki/spaces/SSD/pages/1573617663/API+-+Getting+Started, "Base Url https://console.springserve.com/"); the document Magnite serves declares no servers[] block because the Swagger UI infers the host from window.location.
    - url: https://console.clearline.magnite.com/api/v1
      description: ClearLine console. The identical contract is served from ClearLine's own host; base URL published at springserve.atlassian.net/wiki/spaces/CLD/pages/3649929217/Clearline+API+SDK.
  /api/v1/reports/{id}:
    get:
      summary: Get Report
      parameters:
      - name: id
        in: path
        schema:
          type: string
        required: true
      - name: sort
        in: query
        schema:
          type: string
      - name: limit
        in: query
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: string
      - name: source
        in: query
        schema:
          type: string
          description: The source of the report request
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Reports
      operationId: reports_id_get
    servers:
    - url: https://console.springserve.com/api/v1
      description: SpringServe console. Added by API Evangelist from the published documentation (springserve.atlassian.net/wiki/spaces/SSD/pages/1573617663/API+-+Getting+Started, "Base Url https://console.springserve.com/"); the document Magnite serves declares no servers[] block because the Swagger UI infers the host from window.location.
    - url: https://console.clearline.magnite.com/api/v1
      description: ClearLine console. The identical contract is served from ClearLine's own host; base URL published at springserve.atlassian.net/wiki/spaces/CLD/pages/3649929217/Clearline+API+SDK.
  /api/v1/reports/download/{id}:
    get:
      summary: Download
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: zipped
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Download
          content:
            application/json:
              schema:
                type: object
      tags:
      - Reports
      operationId: reports_download_id_get
    servers:
    - url: https://console.springserve.com/api/v1
      description: SpringServe console. Added by API Evangelist from the published documentation (springserve.atlassian.net/wiki/spaces/SSD/pages/1573617663/API+-+Getting+Started, "Base Url https://console.springserve.com/"); the document Magnite serves declares no servers[] block because the Swagger UI infers the host from window.location.
    - url: https://console.clearline.magnite.com/api/v1
      description: ClearLine console. The identical contract is served from ClearLine's own host; base URL published at springserve.atlassian.net/wiki/spaces/CLD/pages/3649929217/Clearline+API+SDK.
components:
  examples:
    report_create_simple:
      summary: Simple
      value:
        date_range: Yesterday
        dimensions:
        - supply_tag_id
        metrics:
        - impressions
        - revenue
    report_create_full:
      summary: Full
      value:
        async: true
        currency: USD
        date_range: Yesterday
        interval: cumulative
        timezone: UTC
        dimensions:
        - supply_tag_id
        - demand_tag_id
        metrics:
        - impressions
        - revenue
        - fill_rate
        - cpm
    report_create_full_2:
      summary: Full
      value:
        async: false
        csv: false
        currency: USD
        date_range: Yesterday
        dimensions:
        - supply_tag_id
        - demand_tag_id
        filters:
        - dimension: supply_tag_id
          type: values
          values:
          - 1
          is_include: true
          is_exact_match: false
        - dimension: demand_tag_id
          type: values
          values:
          - 1
          is_include: false
          is_exact_match: false
        having:
        - metric: impressions
          max: false
          value: 1
        interval: day
        metrics:
        - impressions
        - revenue
        - fill_rate
        - cpm
        sort:
        - impressions desc
        timezone: Etc/UTC
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: SpringServe authorization token based authentication.
    bearer_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: SpringServe authorization bearer token based authentication.  This key is included in the response from the /api/v0/auth and /api/v1/auth endpoints.  This key will be automatically set if you run the example for /api/v0/auth or /api/v1/auth
x-refined-from:
- rubicon-project-springserve-v0-openapi.yml
- rubicon-project-springserve-v1-openapi.yml
x-servers-added-by: https://apievangelist.com — not present in the upstream document; see openapi/_original/ for the verbatim spec.