Cuebiq

Cuebiq KPIs V2 - Shared Campaign Reports API

The KPIs V2 - Shared Campaign Reports API from Cuebiq — 11 operation(s) for kpis v2 - shared campaign reports.

GitHub OpenAPI

Operations 11

GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/cuts All cut combinations #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/dwell-time Dwell Time #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/impressions Impressions #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/incremental-visits Incremental Projected Visits #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/kpi-analysis-by-cut Kpi Analysis By Cut #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/measured-people Measured People #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/measured-visits Measured Visits #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/projected-visits Projected Visits #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/reached-people Reached People #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/uplift Uplift with confidence interval information #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/visit-rate Visit Rate #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/cuebiq/openapi/cuebiq-kpis-v2-shared-campaign-reports-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/cuebiq/json-schema/cuebiq-performance-kpis-schema.json
📊
JSONSchema
https://artifacts.apis.io/cuebiq/json-schema/cuebiq-kpi-analysis-by-cut-schema.json
📊
JSONSchema
https://artifacts.apis.io/cuebiq/json-schema/cuebiq-create-campaign-report-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/cuebiq/json-schema/cuebiq-post-geoset-request-body-raw-schema.json
📊
JSONSchema
https://artifacts.apis.io/cuebiq/json-schema/cuebiq-create-campaign-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/cuebiq/json-schema/cuebiq-campaign-schema.json

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/cuebiq:cuebiq-kpis-v2-shared-campaign-reports-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

cuebiq-kpis-v2-shared-campaign-reports-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cuebiq KPIs V2 - Shared Campaign Reports API
  description: Create and manage Campaigns and Geoset via Cuebiq external APIs
  version: 0.1.0
servers:
- url: https://...
  description: Cuebiq API gateway
security:
- cuebiq_auth: []
tags:
- name: KPIs V2 - Shared Campaign Reports
paths:
  /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/cuts:
    get:
      summary: All cut combinations
      operationId: getSharedCampaignReportCuts
      tags:
      - KPIs V2 - Shared Campaign Reports
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      - name: reportId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Request succeeded
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Cut'
        '401':
          description: User not authorized!
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: User not authorized to perform operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Kpi data unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
  /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/dwell-time:
    get:
      summary: Dwell Time
      description: Understand how long exposed and control visitors spend in-store when they make a visit, grouped by time interval.
      operationId: getSharedCampaignReportDwellTime
      tags:
      - KPIs V2 - Shared Campaign Reports
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      - name: reportId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Request succeeded
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DwellTime'
        '401':
          description: User not authorized!
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: User not authorized to perform operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Kpi data unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
  /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/impressions:
    get:
      summary: Impressions
      description: A total count of impressions served.
      operationId: getSharedCampaignReportImpression
      tags:
      - KPIs V2 - Shared Campaign Reports
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      - name: reportId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Request succeeded
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Impressions'
        '401':
          description: User not authorized!
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: User not authorized to perform operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Kpi data unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
  /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/incremental-visits:
    get:
      summary: Incremental Projected Visits
      description: The number of projected visits that can be attributed to campaign exposure.
      operationId: getSharedCampaignReportIncrementalVisits
      tags:
      - KPIs V2 - Shared Campaign Reports
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      - name: reportId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Request succeeded
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IncrementalVisits'
        '401':
          description: User not authorized!
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: User not authorized to perform operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Kpi data unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
  /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/kpi-analysis-by-cut:
    get:
      summary: Kpi Analysis By Cut
      operationId: getSharedCampaignReportKpiAnalysisByCut
      tags:
      - KPIs V2 - Shared Campaign Reports
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      - name: reportId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Request succeeded
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/KpiAnalysisByCut'
        '401':
          description: User not authorized!
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: User not authorized to perform operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Kpi data unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
  /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/measured-people:
    get:
      summary: Measured People
      description: Reached people who are also in Cuebiq’s universe of devices.
      operationId: getSharedCampaignReportMeasuredPeople
      tags:
      - KPIs V2 - Shared Campaign Reports
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      - name: reportId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Request succeeded
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MeasuredPeople'
        '401':
          description: User not authorized!
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: User not authorized to perform operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Kpi data unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
  /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/measured-visits:
    get:
      summary: Measured Visits
      description: The total number of visits made by measured people within the conversion window.
      operationId: getSharedCampaignReportMeasuredVisits
      tags:
      - KPIs V2 - Shared Campaign Reports
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      - name: reportId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Request succeeded
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MeasuredVisits'
        '401':
          description: User not authorized!
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: User not authorized to perform operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Kpi data unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
  /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/projected-visits:
    get:
      summary: Projected Visits
      description: 'An estimate of how many visits we would have seen if all reached people were in Cuebiq’s panel.

        In other words, measured visits projected to align with the estimated number of reached people.'
      operationId: getSharedCampaignReportProjectedVisits
      tags:
      - KPIs V2 - Shared Campaign Reports
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      - name: reportId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Request succeeded
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProjectedVisits'
        '401':
          description: User not authorized!
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: User not authorized to perform operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Kpi data unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
  /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/reached-people:
    get:
      summary: Reached People
      description: An estimate of people exposed to an impression in the campaign
      operationId: getSharedCampaignReportReachedPeople
      tags:
      - KPIs V2 - Shared Campaign Reports
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      - name: reportId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Request succeeded
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReachedPeople'
        '401':
          description: User not authorized!
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: User not authorized to perform operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Kpi data unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
  /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/uplift:
    get:
      summary: Uplift with confidence interval information
      description: The percentage difference in visit rate between measured people and a matching group of unexposed people.
      operationId: getSharedCampaignReportUplift
      tags:
      - KPIs V2 - Shared Campaign Reports
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      - name: reportId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Request succeeded
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Uplift1'
        '401':
          description: User not authorized!
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: User not authorized to perform operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Kpi data unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
  /v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/visit-rate:
    get:
      summary: Visit Rate
      description: The percentage of measured people that visited a store within the conversion window.
      operationId: getSharedCampaignReportVisitRate
      tags:
      - KPIs V2 - Shared Campaign Reports
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      - name: reportId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Request succeeded
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VisitRate'
        '401':
          description: User not authorized!
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: User not authorized to perform operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Kpi data unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
components:
  schemas:
    ErrorMessage:
      required:
      - timestamp
      - details
      type: object
      properties:
        status:
          format: int32
          type: integer
        message:
          type:
          - string
          - 'null'
        link:
          type:
          - string
          - 'null'
        timestamp:
          $ref: '#/components/schemas/ZonedDateTime'
        details:
          type: array
          items:
            type: string
    ReachedPeople:
      required:
      - date
      type: object
      properties:
        date:
          $ref: '#/components/schemas/LocalDate'
        value:
          format: double
          type: number
    MeasuredPeople:
      required:
      - date
      type: object
      properties:
        date:
          $ref: '#/components/schemas/LocalDate'
        value:
          format: int64
          type: integer
    ZonedDateTime:
      format: date-time
      type: string
      example: '2022-03-10T12:15:50-04:00'
    Uplift:
      type: object
      properties:
        value:
          format: double
          type: number
        lowerBound:
          format: double
          type: number
        upperBound:
          format: double
          type: number
        confidenceIndex:
          format: double
          type: number
    LocalDate:
      format: date
      type: string
      example: '2022-03-10'
    IncrementalVisits:
      required:
      - date
      type: object
      properties:
        date:
          $ref: '#/components/schemas/LocalDate'
        value:
          format: double
          type: number
        lowerBound:
          format: double
          type: number
        upperBound:
          format: double
          type: number
    UUID:
      format: uuid
      pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}'
      type: string
    Uplift1:
      required:
      - date
      type: object
      properties:
        date:
          $ref: '#/components/schemas/LocalDate'
        value:
          format: double
          type: number
        lowerBound:
          format: double
          type: number
        upperBound:
          format: double
          type: number
        confidenceIndex:
          format: double
          type: number
    Impressions:
      required:
      - date
      type: object
      properties:
        date:
          $ref: '#/components/schemas/LocalDate'
        value:
          format: double
          type: number
    DwellTime:
      type: object
      properties:
        start:
          format: int64
          type: integer
        end:
          format: int64
          type: integer
        exposed:
          format: int64
          type: integer
        controlGroup:
          format: int64
          type: integer
    Cut:
      required:
      - parameters
      type: object
      properties:
        impressions:
          format: double
          type: number
        measuredVisits:
          format: double
          type: number
        projectedVisits:
          format: double
          type: number
        walkThroughRate:
          format: double
          type: number
        parameters:
          type: object
          additionalProperties:
            type: string
    MeasuredVisits:
      required:
      - date
      type: object
      properties:
        date:
          $ref: '#/components/schemas/LocalDate'
        value:
          format: int64
          type: integer
    VisitRate:
      required:
      - date
      type: object
      properties:
        date:
          $ref: '#/components/schemas/LocalDate'
        value:
          format: double
          type: number
    ProjectedVisits:
      required:
      - date
      type: object
      properties:
        date:
          $ref: '#/components/schemas/LocalDate'
        value:
          format: double
          type: number
    KpiAnalysisByCut:
      required:
      - runDate
      - uplift
      - parameters
      type: object
      properties:
        runDate:
          $ref: '#/components/schemas/LocalDate'
        impressions:
          format: double
          type: number
        measuredPeople:
          format: int64
          type: integer
        reachedPeople:
          format: double
          type: number
        uplift:
          $ref: '#/components/schemas/Uplift'
        projectedIncrementalVisits:
          format: double
          type: number
        visitRate:
          format: double
          type: number
        measuredVisits:
          format: double
          type: number
        projectedVisits:
          format: double
          type: number
        walkThroughRate:
          format: double
          type: number
        parameters:
          type: object
          additionalProperties:
            type: string
  securitySchemes:
    cuebiq_auth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.cuebiq.com/auth/realms/Customers/protocol/openid-connect/token
          refreshUrl: https://auth.cuebiq.com/auth/realms/Customers/protocol/openid-connect/token