Cuebiq

Cuebiq KPIs V2 - Shared Campaigns API

The KPIs V2 - Shared Campaigns API from Cuebiq — 9 operation(s) for kpis v2 - shared campaigns.

GitHub OpenAPI

Operations 9

GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/impressions Impressions #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/incremental-visits Incremental Projected Visits #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/measured-people Measured People #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/measured-visits Measured Visits #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/projected-visits Measured Visits #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/rankings Performance Rankings #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/reached-people Reached People #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/uplift Uplift with confidence interval information #
GET /v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/visit-rate Visit Rate #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/cuebiq/openapi/cuebiq-kpis-v2-shared-campaigns-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-campaigns-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-campaigns-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cuebiq KPIs V2 - Shared Campaigns 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 Campaigns
paths:
  /v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/impressions:
    get:
      summary: Impressions
      description: A total count of impressions served.
      operationId: getSharedCampaignImpression
      tags:
      - KPIs V2 - Shared Campaigns
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      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}/kpis/incremental-visits:
    get:
      summary: Incremental Projected Visits
      description: The number of projected visits that can be attributed to campaign exposure.
      operationId: getSharedCampaignIncrementalVisits
      tags:
      - KPIs V2 - Shared Campaigns
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      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}/kpis/measured-people:
    get:
      summary: Measured People
      description: Reached people who are also in Cuebiq’s universe of devices.
      operationId: getSharedCampaignMeasuredPeople
      tags:
      - KPIs V2 - Shared Campaigns
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      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}/kpis/measured-visits:
    get:
      summary: Measured Visits
      description: The total number of visits made by measured people within the conversion window.
      operationId: getSharedCampaignMeasuredVisits
      tags:
      - KPIs V2 - Shared Campaigns
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      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}/kpis/projected-visits:
    get:
      summary: Measured Visits
      description: The total number of visits made by measured people within the conversion window.
      operationId: getSharedCampaignProjectedVisits
      tags:
      - KPIs V2 - Shared Campaigns
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      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}/kpis/rankings:
    get:
      summary: Performance Rankings
      description: Get performance rankings on reports grouped by KPIs.
      operationId: getSharedCampaignRankings
      tags:
      - KPIs V2 - Shared Campaigns
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      responses:
        '200':
          description: Request succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PerformanceRankingResponse'
        '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}/kpis/reached-people:
    get:
      summary: Reached People
      description: An estimate of people exposed to an impression in the campaign
      operationId: getSharedCampaignReachedPeople
      tags:
      - KPIs V2 - Shared Campaigns
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      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}/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: getSharedCampaignUplift
      tags:
      - KPIs V2 - Shared Campaigns
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      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}/kpis/visit-rate:
    get:
      summary: Visit Rate
      description: The percentage of measured people that visited a store within the conversion window.
      operationId: getSharedCampaignVisitRate
      tags:
      - KPIs V2 - Shared Campaigns
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          allOf:
          - {}
          - $ref: '#/components/schemas/UUID'
      - name: customerId
        in: path
        required: true
        schema:
          format: int32
          type: integer
      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'
    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
    LocalDate:
      format: date
      type: string
      example: '2022-03-10'
    PerformanceRankingResponse:
      required:
      - rankings
      type: object
      properties:
        rankings:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/RankedKpi'
    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
    MeasuredVisits:
      required:
      - date
      type: object
      properties:
        date:
          $ref: '#/components/schemas/LocalDate'
        value:
          format: int64
          type: integer
    RankedKpi:
      required:
      - id
      - name
      type: object
      properties:
        id:
          $ref: '#/components/schemas/UUID'
        name:
          type: string
        rank:
          format: int32
          type:
          - integer
          - 'null'
        value:
          format: double
          type:
          - number
          - 'null'
    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
    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
  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