GET
/
pique-campaign
/
{id}
/
video-performance
Get campaign video performance data
curl --request GET \
  --url https://api.ubpass.co/v1/pique-campaign/{id}/video-performance \
  --header 'api-key: <api-key>'
{
  "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"
    },
    {
      "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"
    }
  ],
  "cursor": "1f089d37-6145-6709-af59-99631cec7ab6",
  "hasMore": true
}

Authorizations

​
api-key
string
header
required

API Key authentication

Headers

​
x-workspace-id
string

Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user

Path Parameters

​
id
string
required

Unique identifier of the Pique Campaign

Query Parameters

​
cursor
string

Pagination cursor for fetching the next set of performance records. Use the 'cursor' value from the previous response.

​
limit
integer

Number of performance records to return per page (1-20, max 20)

Required range: 1 <= x <= 20

Response

Video performance data retrieved successfully

​
items
object[]
​
cursor
string
​
hasMore
boolean