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

# Get Pique Campaign video performance data

> Retrieve video performance metrics for a specific Pique Campaign.




## OpenAPI

````yaml api-reference/openapi.json get /pique-campaign/{id}/video-performance
openapi: 3.1.0
info:
  title: Unblocked Wallet Passes API
  description: Unblocked Wallet Passes API
  version: 1.0.0
servers:
  - url: https://api.ubpass.co/v1
    description: Generated server url
security:
  - AccessToken: []
  - APIKey: []
tags:
  - name: Pique
    description: Get Pique Campaigns and their video performance data
  - name: Passport - Passes
    description: >-
      Create, update, retrieve, and delete wallet passes for Apple and Google
      platforms
  - name: Passport - Push Notifications
    description: Create, update, get, and delete wallet pass notifications
  - name: Passport - Locations
    description: Create, update, get, and delete wallet pass locations
  - name: Upload APIs
    description: Upload and manage pass assets and images
paths:
  /pique-campaign/{id}/video-performance:
    get:
      tags:
        - Pique
      summary: Get Pique Campaign video performance data
      description: |
        Retrieve video performance metrics for a specific Pique Campaign.
      operationId: getPiqueCampaignVideoPerformance
      parameters:
        - name: id
          in: path
          description: Unique identifier of the Pique Campaign
          required: true
          schema:
            type: string
            pattern: ^[a-zA-Z0-9-_]+$
          example: 1f089d37-5ebe-6778-af59-99631cec7ab5
        - name: cursor
          in: query
          description: >-
            Pagination cursor for fetching the next set of performance records.
            Use the 'cursor' value from the previous response.
          required: false
          schema:
            type: string
          example: 1f089d37-6145-6709-af59-99631cec7ab6
        - name: limit
          in: query
          description: Number of performance records to return per page (1-20, max 20)
          required: false
          schema:
            type: integer
            maximum: 20
            minimum: 1
          example: 20
        - name: x-workspace-id
          in: header
          description: >-
            Workspace ID to perform the operation in. If not provided, system
            will use the first one assigned to the user
          required: false
          schema:
            type: string
            pattern: ^[a-zA-Z0-9-_]+$
          example: 1f089d29-6f9c-66c2-af59-99631cec7ab5
      responses:
        '200':
          description: Video performance data retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BXPagedList'
              examples:
                Performance Data Response:
                  summary: Paginated video performance metrics
                  description: Performance Data Response
                  value:
                    items:
                      - id: 1f089d37-6145-6709-af59-99631cec7ab5
                        createdTime: '2025-09-04T21:09:36.063Z'
                        updatedTime: '2025-09-04T21:09:36.063Z'
                        createdBy: 1ef58ae6-40ac-6fd2-96af-45801844c4e2
                        updatedBy: 1ef58ae6-40ac-6fd2-96af-45801844c4e2
                        workspaceId: 1f089d29-6f9c-66c2-af59-99631cec7ab5
                        campaignId: 1f089d37-5ebe-6778-af59-99631cec7ab5
                        platform: TikTok
                        videoURL: https://tiktok.com/@creator/video/123
                        creatorHandle: '@fashioncreator'
                        views: 150000
                        likes: 12000
                        shares: 800
                        comments: 450
                        saves: 2100
                        datePosted: '2024-01-15'
                        deliveredViews: 45000
                        startViews: 90000
                        startLikes: 7800
                        startComments: 292
                        startShares: 480
                        startSaves: 1470
                      - id: 1f089d37-6145-6709-af59-99631cec7ab6
                        createdTime: '2025-09-04T21:09:36.063Z'
                        updatedTime: '2025-09-04T21:09:36.063Z'
                        createdBy: 1ef58ae6-40ac-6fd2-96af-45801844c4e2
                        updatedBy: 1ef58ae6-40ac-6fd2-96af-45801844c4e2
                        workspaceId: 1f089d29-6f9c-66c2-af59-99631cec7ab5
                        campaignId: 1f089d37-5ebe-6778-af59-99631cec7ab5
                        platform: Instagram
                        videoURL: https://instagram.com/p/ABC123
                        creatorHandle: '@lifestyleblogger'
                        views: 85000
                        likes: 6500
                        shares: 320
                        comments: 180
                        saves: 1200
                        datePosted: '2024-01-16'
                        deliveredViews: 25500
                        startViews: 51000
                        startLikes: 4225
                        startComments: 117
                        startShares: 192
                        startSaves: 840
                    cursor: 1f089d37-6145-6709-af59-99631cec7ab6
                    hasMore: true
        '401':
          description: Unauthorized - Invalid or missing authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildXAPIError'
              examples:
                Unauthorized Error:
                  summary: Authentication failed
                  description: Unauthorized Error
                  value:
                    txId: Root=1-68d3693c-26a3db2278c7668f5e086711
                    timestamp: 24-09-2025 03:45:00
                    errorCode: UNAUTHORIZED
                    errorMessage: UNAUTHORIZED.
        '404':
          description: Campaign not found or no performance data available
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildXAPIError'
              examples:
                Not Found Error:
                  summary: Campaign or performance data not found
                  description: Not Found Error
                  value:
                    txId: Root=1-68d30006-614205915f11c2e02dc1dcd3
                    timestamp: 23-09-2025 08:16:06
                    errorCode: NOT_FOUND
                    errorMessage: Not found.
                    context:
                      id: 1f061c3e-ed45-60e0-884d-85e4657e9d601
components:
  schemas:
    BXPagedList:
      type: object
      properties:
        items:
          type: array
          items: {}
        cursor:
          type: string
        hasMore:
          type: boolean
    BuildXAPIError:
      type: object
      properties:
        txId:
          type: string
        timestamp:
          type: string
          format: date-time
        errorCode:
          type: string
        errorMessage:
          type: string
        context:
          type: object
          additionalProperties: {}
  securitySchemes:
    AccessToken:
      type: http
      description: Bearer token authentication
      scheme: bearer
      bearerFormat: JWT
    APIKey:
      type: apiKey
      description: API Key authentication
      name: api-key
      in: header

````