GET
/
pique-campaign
/
{id}
Get campaign by ID
curl --request GET \
  --url https://api.ubpass.co/v1/pique-campaign/{id} \
  --header 'api-key: <api-key>'
{
  "id": "1f089d37-5ebe-6778-af59-99631cec7ab5",
  "createdTime": "2025-09-04T21:09:36.027Z",
  "updatedTime": "2025-09-04T21:11:01.734Z",
  "createdBy": "1ef58ae6-40ac-6fd2-96af-45801844c4e2",
  "updatedBy": "1ef58ae6-40ac-6fd2-96af-45801844c4e2",
  "workspaceId": "1f089d29-6f9c-66c2-af59-99631cec7ab5",
  "accountId": "1f089d29-6fa8-6a13-af59-99631cec7ab5",
  "name": "Regression Campaign",
  "type": "Enterprise",
  "status": "Paused",
  "startDate": "2025-09-10",
  "isPublished": true,
  "campaignDataFileKey": "campaigns/data/campaign-123.json",
  "videoPerformanceFileKey": "campaigns/performance/campaign-123.csv",
  "campaignData": {
    "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",
    "campaignId": "1f089d37-5ebe-6778-af59-99631cec7ab5",
    "totalViews": 1250000,
    "totalClicks": 89000,
    "totalLikes": 12500,
    "totalCreators": 8750,
    "totalComments": 15600,
    "totalShares": 4200,
    "totalVideos": 12.5,
    "instagramViews": 750000,
    "instagramLikes": 500000,
    "instagramShares": 750000,
    "instagramComments": 500000,
    "tiktokViews": 750000,
    "tiktokLikes": 500000,
    "tiktokShares": 750000,
    "tiktokComments": 500000,
    "assetFolderLink": "https://drive.google.com/folder/campaign-assets",
    "rec1": "Campaign performed well with high engagement rates.\nHealth-focused creators are driving 34% higher engagement rates.",
    "rec2": "Consider partnering with more wellness influencers for upcoming campaigns.\nTikTok content featuring 'morning routine' themes shows 28% better performance than Instagram.",
    "rec3": "Optimize posting strategy around wellness routines."
  }
}

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

Response

Campaign found and returned successfully

​
id
string
​
createdTime
string<date-time>

The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
updatedTime
string<date-time>

The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
createdBy
string

The user who created the entity.

​
updatedBy
string

The user who last updated the entity.

​
workspaceId
string

The ID of the workspace to which this entity belongs.

​
accountId
string
​
name
string
​
type
enum<string>
Available options:
SocialPush,
BrandDiscovery,
SocialValidation,
ConversionDriver,
Enterprise,
ViralBoost
​
status
enum<string>
Available options:
Prepping,
InProgress,
Completed,
Paused
​
startDate
string<date>
​
isPublished
boolean
​
campaignData
object
​
campaignDataFileKey
string
​
videoPerformanceFileKey
string