Search and filter Pique Campaigns
curl --request GET \
--url https://api.ubpass.co/v1/pique-campaign \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ubpass.co/v1/pique-campaign"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ubpass.co/v1/pique-campaign', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ubpass.co/v1/pique-campaign",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ubpass.co/v1/pique-campaign"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ubpass.co/v1/pique-campaign")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ubpass.co/v1/pique-campaign")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "1f0aeeff-c45d-64e6-a63e-e1179780e82f",
"createdTime": "2025-10-22T02:37:00.169Z",
"updatedTime": "2025-10-22T02:59:23.866Z",
"createdBy": "1efe824d-1c2a-63b4-81ed-eb91480f4c4e",
"updatedBy": "1efe824d-1c2a-63b4-81ed-eb91480f4c4e",
"workspaceId": "1f08a693-3d4b-6d6d-8b30-81ed80c53926",
"accountId": "1f08a693-3d55-69ae-8b30-81ed80c53926",
"name": "BoostedPost Campaign 1761100620",
"type": "BoostedPost",
"status": "NotStarted",
"startDate": "2025-12-01",
"isPublished": false,
"campaignData": {},
"videoPerformanceFileInfo": {
"fileName": "campaign-videos.csv",
"url": "http://localhost:9012/bx-wallet-passes-setup-dev/pique-campaigns/1f0aeeff-c45d-64e6-a63e-e1179780e82f/campaign-videos.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251022T232937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=60&X-Amz-Credential=minioadmin%2F20251022%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=e05a5cae5730062d61c24caaf688923a6aeaacd4a899bcd7705f353ed8c0e097"
},
"platforms": [
"Instagram",
"TikTok"
],
"targetViews": 100000,
"beforeViews": 50000,
"afterViews": 450000,
"deliveredViews": 2000,
"contentLink": "https://example.com/boosted-campaign-content",
"submissionNotes": "Boosted campaign test",
"beforeImage": {
"fileName": "beforeImage.png",
"url": "http://localhost:9012/bx-wallet-passes-setup-dev/pique-campaigns/1f0aeeff-c45d-64e6-a63e-e1179780e82f/beforeImage.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251022T232937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=59&X-Amz-Credential=minioadmin%2F20251022%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=45d22790c4d31620e60783bb4c3b6c87ffdc6cbb8d61705832e32a0ee772ed22"
},
"afterImage": {
"fileName": "afterImage.png",
"url": "http://localhost:9012/bx-wallet-passes-setup-dev/pique-campaigns/1f0aeeff-c45d-64e6-a63e-e1179780e82f/afterImage.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251022T232937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=60&X-Amz-Credential=minioadmin%2F20251022%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b7336f06e64514acf03173497642438d786ee239cc0039f25eba41fd803f6eb6"
}
}
],
"cursor": "1f0aeeff-c45d-64e6-a63e-e1179780e82f",
"hasMore": true
}{
"txId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errorCode": "<string>",
"errorMessage": "<string>",
"context": {}
}{
"txId": "Root=1-68d3693c-26a3db2278c7668f5e086711",
"timestamp": "24-09-2025 03:45:00",
"errorCode": "UNAUTHORIZED",
"errorMessage": "UNAUTHORIZED."
}Pique
Search and filter Pique Campaigns
Search and retrieve Pique Campaigns with optional filtering and pagination.
Features:
- Search campaigns by name using keyword query
- Filter by campaign status (Prepping, InProgress, Completed, Paused, NotStarted, Cancelled)
- Filter by campaign type (BoostedPost, SyndicatedContent)
- Pagination support with cursor-based navigation
- Returns only published campaigns for branded users
Pagination:
- Use
cursorparameter for next page navigation limitcontrols page size (default: 20)- Response includes
itemsarray,cursor, andhasMorefields
GET
/
pique-campaign
Search and filter Pique Campaigns
curl --request GET \
--url https://api.ubpass.co/v1/pique-campaign \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ubpass.co/v1/pique-campaign"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ubpass.co/v1/pique-campaign', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ubpass.co/v1/pique-campaign",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ubpass.co/v1/pique-campaign"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ubpass.co/v1/pique-campaign")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ubpass.co/v1/pique-campaign")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "1f0aeeff-c45d-64e6-a63e-e1179780e82f",
"createdTime": "2025-10-22T02:37:00.169Z",
"updatedTime": "2025-10-22T02:59:23.866Z",
"createdBy": "1efe824d-1c2a-63b4-81ed-eb91480f4c4e",
"updatedBy": "1efe824d-1c2a-63b4-81ed-eb91480f4c4e",
"workspaceId": "1f08a693-3d4b-6d6d-8b30-81ed80c53926",
"accountId": "1f08a693-3d55-69ae-8b30-81ed80c53926",
"name": "BoostedPost Campaign 1761100620",
"type": "BoostedPost",
"status": "NotStarted",
"startDate": "2025-12-01",
"isPublished": false,
"campaignData": {},
"videoPerformanceFileInfo": {
"fileName": "campaign-videos.csv",
"url": "http://localhost:9012/bx-wallet-passes-setup-dev/pique-campaigns/1f0aeeff-c45d-64e6-a63e-e1179780e82f/campaign-videos.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251022T232937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=60&X-Amz-Credential=minioadmin%2F20251022%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=e05a5cae5730062d61c24caaf688923a6aeaacd4a899bcd7705f353ed8c0e097"
},
"platforms": [
"Instagram",
"TikTok"
],
"targetViews": 100000,
"beforeViews": 50000,
"afterViews": 450000,
"deliveredViews": 2000,
"contentLink": "https://example.com/boosted-campaign-content",
"submissionNotes": "Boosted campaign test",
"beforeImage": {
"fileName": "beforeImage.png",
"url": "http://localhost:9012/bx-wallet-passes-setup-dev/pique-campaigns/1f0aeeff-c45d-64e6-a63e-e1179780e82f/beforeImage.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251022T232937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=59&X-Amz-Credential=minioadmin%2F20251022%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=45d22790c4d31620e60783bb4c3b6c87ffdc6cbb8d61705832e32a0ee772ed22"
},
"afterImage": {
"fileName": "afterImage.png",
"url": "http://localhost:9012/bx-wallet-passes-setup-dev/pique-campaigns/1f0aeeff-c45d-64e6-a63e-e1179780e82f/afterImage.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251022T232937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=60&X-Amz-Credential=minioadmin%2F20251022%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b7336f06e64514acf03173497642438d786ee239cc0039f25eba41fd803f6eb6"
}
}
],
"cursor": "1f0aeeff-c45d-64e6-a63e-e1179780e82f",
"hasMore": true
}{
"txId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errorCode": "<string>",
"errorMessage": "<string>",
"context": {}
}{
"txId": "Root=1-68d3693c-26a3db2278c7668f5e086711",
"timestamp": "24-09-2025 03:45:00",
"errorCode": "UNAUTHORIZED",
"errorMessage": "UNAUTHORIZED."
}Authorizations
AccessTokenAPIKey
Bearer token authentication
Headers
Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user
Pattern:
^[a-zA-Z0-9-_]+$Query Parameters
Search keyword to filter campaigns by name (case-insensitive)
Maximum string length:
255Pagination cursor for fetching the next set of results. Use the 'cursor' value from the previous response.
Number of campaigns to return per page (1-20, max 20)
Required range:
1 <= x <= 20Filter campaigns by status. Multiple values allowed.
Available options:
Prepping, InProgress, Completed, Paused, NotStarted, Canceled Filter campaigns by type. Multiple values allowed.
Available options:
BoostedPost, SyndicatedContent Filter by specific campaign ID
Pattern:
^[a-zA-Z0-9-_]+$Filter by a list of campaign IDs