Captiv8 Public API

Campaign Reports 10

Description

Add new campaign report

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{public_api_token}}
URL Variables
KeyValueDescription
campaign_id10645

Campaign id, can be found from compaigns search.

Body
KeyValueDescription
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
Description

Get existing campaign report audience data

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}
URL Variables
KeyValueDescription
campaign_id10645

Campaign id, can be found from compaigns search.

report_id10856

Report id, can be found from search by compaign id.


Description

Get existing campaign report content data

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}
Query
KeyValueDescription
take25

Amount of items in response.

skip0

Amount of items to skip.

sort_bycreation_time

Sort by field.

sort_dirdesc

Sort direction.

creators

Array of creators IDs.

platforms

Array of platforms IDs.

media_types

Array of media_types IDs.

URL Variables
KeyValueDescription
campaign_id10645

Campaign id, can be found from compaigns search.

report_id10856

Report id, can be found from search by compaign id.


Description

Add post URL of creator attached to the campaign

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}
URL Variables
KeyValueDescription
campaign_id10645

Campaign id, can be found from compaigns search.

report_id10856

Report id, can be found from search by compaign id.

Body
{ "url": "dolor" }
Description

Get existing campaign report creators data

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}
Query
KeyValueDescription
take25

Pagination, amount of items in response.

skip0

Pagination, amount of items to skip.

sort_bycreated_at

Sort by field. Sort by field. Ex: title, author, created_at

sort_dirdesc

Sort direction. Ex: asc, desc

q

Search request by title. Ex: Robert

URL Variables
KeyValueDescription
campaign_id10645

Campaign id, can be found from compaigns search.

report_id10856

Report id, can be found from search by compaign id.


Description

Destroy existing campaign report

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}
URL Variables
KeyValueDescription
campaign_id10645

Campaign id, can be found from compaigns search.

report_id10856

Report id, can be found from search by compaign id.

Body
[]
Description

Get existing campaign report

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}
URL Variables
KeyValueDescription
campaign_id10645

Campaign id, can be found from compaigns search.

report_id10856

Report id, can be found from search by compaign id.


Description

Get existing campaign report overview

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}
URL Variables
KeyValueDescription
campaign_id10645

Campaign id, can be found from compaigns search.

report_id10856

Report id, can be found from search by compaign id.


Description

Search campaign reports with filters and pagination

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}
Query
KeyValueDescription
take25

Pagination, amount of items in response.

skip0

Pagination, amount of items to skip.

sort_bycreated_at

Sort by field. Ex: title, author, created_at, updated_at, last_used

sort_dirdesc

Sort direction. Ex: asc, desc

URL Variables
KeyValueDescription
campaign_id10645

Campaign id, can be found from search.


Description

Update existing campaign report

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}
URL Variables
KeyValueDescription
campaign_id10645

Campaign id, can be found from compaigns search.

report_id10856

Report id, can be found from search by compaign id.

Body
{ "title": "Title", "description": "Description", "show_all_audience": false, "show_engaged_audience": false, "show_fraud_flags": true, "split_paid_metrics": false, "eng_rate_by_impressions": false, "auto_hashtags": [], "auto_keywords": [] }

Campaigns 6

Description

Add new campaign

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{public_api_token}}
Body
KeyValueDescription
title

Title

brand

Brand

start_date

Ex: 1599512100, timestamp format

end_date

Ex: 1599512400, timestamp format

budget

Ex: 100000, number

Description

Destroy existing campaign

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{public_api_token}}
URL Variables
KeyValueDescription
campaign_id

Campaign id, can be found from search.

Body
[]
Description

Get existing campaign

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}
URL Variables
KeyValueDescription
campaign_id16712

Campaign id, can be found from search.


Description

Search campaign reports with filters and pagination

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}
URL Variables
KeyValueDescription
campaign_id16712

Campaign id, can be found from search

creator_id81154891

Creator id of campaign


Description

Update existing campaign

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{public_api_token}}
URL Variables
KeyValueDescription
campaign_id

Campaign id, can be found from search.

Body
KeyValueDescription
title

Title

brand

Brand

start_date

Ex: 1599512100

end_date

Ex: 1599512400

budget

Ex: 100000

Content Topics 1

Description

Get list of content topics

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}

Creators 3

Creators API

Description

Get creator profile data

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}
URL Variables
KeyValueDescription
slugCaptiv8VLE4K

Use slug from search, ex: Captiv8VLE4K


Description

Search creator by social handle

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
X-API-Key{{apikey}}
Query
KeyValueDescription
social_accountcaptiv8

Username, ex: captiv8

social_networkinstagram

Social networks: youtube, instagram, twitter, facebook, tiktok, etc. Ex: instagram


Available Variables 1

KeyValueType
apikey{{apikey}}