Add new campaign report
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{public_api_token}} |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
Key | Value | Description |
---|---|---|
title | Title | |
description | Description | |
show_all_audience | Ex: 0 | |
show_engaged_audience | Ex: 1 | |
show_fraud_flags | Ex: 0 | |
split_paid_metrics | Ex: 0 | |
eng_rate_by_impressions | Ex: 1 | |
is_auto_post | Ex: 0 | |
auto_hashtags | ||
auto_keywords |
Get existing campaign report audience data
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
report_id | 10856 | Report id, can be found from search by compaign id. |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
report_id | 10856 | Report id, can be found from search by compaign id. |
Get existing campaign report content data
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
take | 25 | Amount of items in response. |
skip | 0 | Amount of items to skip. |
sort_by | creation_time | Sort by field. |
sort_dir | desc | Sort direction. |
creators | Array of creators IDs. | |
platforms | Array of platforms IDs. | |
media_types | Array of media_types IDs. |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
report_id | 10856 | Report id, can be found from search by compaign id. |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
take | 25 | Amount of items in response. |
skip | 0 | Amount of items to skip. |
sort_by | creation_time | Sort by field. |
sort_dir | desc | Sort direction. |
creators | Array of creators IDs. | |
platforms | Array of platforms IDs. | |
media_types | Array of media_types IDs. |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
report_id | 10856 | Report id, can be found from search by compaign id. |
Add post URL of creator attached to the campaign
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
report_id | 10856 | Report id, can be found from search by compaign id. |
Get existing campaign report creators data
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
take | 25 | Pagination, amount of items in response. |
skip | 0 | Pagination, amount of items to skip. |
sort_by | created_at | Sort by field. Sort by field. Ex: title, author, created_at |
sort_dir | desc | Sort direction. Ex: asc, desc |
q | Search request by title. Ex: Robert |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
report_id | 10856 | Report id, can be found from search by compaign id. |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
take | 25 | Pagination, amount of items in response. |
skip | 0 | Pagination, amount of items to skip. |
sort_by | created_at | Sort by field. Sort by field. Ex: title, author, created_at |
sort_dir | desc | Sort direction. Ex: asc, desc |
q | Search request by title. Ex: Robert |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
report_id | 10856 | Report id, can be found from search by compaign id. |
Destroy existing campaign report
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
report_id | 10856 | Report id, can be found from search by compaign id. |
Get existing campaign report
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
report_id | 10856 | Report id, can be found from search by compaign id. |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
report_id | 10856 | Report id, can be found from search by compaign id. |
Get existing campaign report overview
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
report_id | 10856 | Report id, can be found from search by compaign id. |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
report_id | 10856 | Report id, can be found from search by compaign id. |
Search campaign reports with filters and pagination
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
take | 25 | Pagination, amount of items in response. |
skip | 0 | Pagination, amount of items to skip. |
sort_by | created_at | Sort by field. Ex: title, author, created_at, updated_at, last_used |
sort_dir | desc | Sort direction. Ex: asc, desc |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from search. |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
take | 25 | Pagination, amount of items in response. |
skip | 0 | Pagination, amount of items to skip. |
sort_by | created_at | Sort by field. Ex: title, author, created_at, updated_at, last_used |
sort_dir | desc | Sort direction. Ex: asc, desc |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from search. |
Update existing campaign report
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from compaigns search. |
report_id | 10856 | Report id, can be found from search by compaign id. |
Add new campaign
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{public_api_token}} |
Key | Value | Description |
---|---|---|
title | Title | |
brand | Brand | |
start_date | Ex: 1599512100, timestamp format | |
end_date | Ex: 1599512400, timestamp format | |
budget | Ex: 100000, number |
Destroy existing campaign
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{public_api_token}} |
Key | Value | Description |
---|---|---|
campaign_id | Campaign id, can be found from search. |
Get existing campaign
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
campaign_id | 16712 | Campaign id, can be found from search. |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
campaign_id | 10645 | Campaign id, can be found from search. |
Search campaign reports with filters and pagination
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
campaign_id | 16712 | Campaign id, can be found from search |
creator_id | 81154891 | Creator id of campaign |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
campaign_id | 16712 | Campaign id, can be found from search |
creator_id | 81154891 | Creator id of campaign |
Search campaigns with filters and pagination
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
take | 25 | Pagination, amount of items in response. |
skip | 0 | Pagination, amount of items to skip. |
sort_by | created_at | Sort by field. Ex: title, created_at, status |
sort_dir | desc | Sort direction. Ex: asc, desc |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
take | 25 | Pagination, amount of items in response. |
skip | 0 | Pagination, amount of items to skip. |
sort_by | created_at | Sort by field. Ex: title, created_at, status |
sort_dir | desc | Sort direction. Ex: asc, desc |
Update existing campaign
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{public_api_token}} |
Key | Value | Description |
---|---|---|
campaign_id | Campaign id, can be found from search. |
Key | Value | Description |
---|---|---|
title | Title | |
brand | Brand | |
start_date | Ex: 1599512100 | |
end_date | Ex: 1599512400 | |
budget | Ex: 100000 |
Get list of content topics
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Creators API
Get creator profile data
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
slug | Captiv8VLE4K | Use slug from search, ex: Captiv8VLE4K |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
slug | Captiv8VLE4K | Use slug from search, ex: Captiv8VLE4K |
Search creators with filters and pagination
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
query | Ronaldo | Ex: Ronaldo |
sort_by | reach | Ex: eng_rate, reach (total followers) |
sort_dir | desc | Ex: desc, asc |
take | 25 | Pagination: page size |
skip | 0 | Pagination: skip that much |
brands | ||
brands_or | 1 | |
age | 13-17 |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
query | Ronaldo | Ex: Ronaldo |
sort_by | reach | Ex: eng_rate, reach (total followers) |
sort_dir | desc | Ex: desc, asc |
take | 25 | Pagination: page size |
skip | 0 | Pagination: skip that much |
brands | ||
brands_or | 1 | |
age | 13-17 |
Search creator by social handle
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
social_account | captiv8 | Username, ex: captiv8 |
social_network | Social networks: youtube, instagram, twitter, facebook, tiktok, etc. Ex: instagram |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json | |
X-API-Key | {{apikey}} |
Key | Value | Description |
---|---|---|
social_account | captiv8 | Username, ex: captiv8 |
social_network | Social networks: youtube, instagram, twitter, facebook, tiktok, etc. Ex: instagram |
Key | Value | Type |
---|---|---|
apikey | {{apikey}} |