GuidesChangelogAPI Reference
API Reference

/api/v5/campaign/

get
https://percolate.com/api/v5/campaign/

Get a list of campaigns by ids.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to owned

Filter objects owned by the scope itself and/or shared from other scopes ^(owned|shared)$.

string

A CSV of unique campaign IDs to filter by.

string

Filter objects with/without approved/rejected/incomplete workflows. The complete filter option will eventually be deprecated in favor of approved.

string

A CSV of scope IDs to filter by.

boolean
Defaults to false

Look inside any child scopes in addition to the supplied ones.

{metadataSearch}
object

This is a dynamic query parameter name, used to filter endpoint response by its metadata field. The {schemaFieldId} template represents the schema id and field name concatenated together by a dot (.). In effect, it expands to the sub-template {schema-id}.{schema-field-name}. The {schema-id} template is the UID of a schema. The {schema-field-name} template is a path separated by the forward slash (/) (to allow for representation of nested objects).
The value of the query parameter is a CSV of strings appropriate for the given metadata field.
Valid options are:
metadata.{schemaFieldId}: string
 has_metadata.{schemaFieldId}: true - Filter by the existence of a metadata field.
metadata.{schemaFieldId}.from: string (date) - Filter by a metadata date field (inclusive)
 metadata.{schemaFieldId}.to: string (date) - Filter by a metadata date field (exclusive).

See the examples for each valid option:
metadata.schema:1.live_date_range
 has_metadata.schema:1.live_date_range
metadata.schema:1.live_date_range/from
 metadata.schema:1.live_date_range/to

integer

Limit the number of paginated results.

integer

A 0-based offset to adjust the pagination window.

date-time

Filter campaigns with start_at on or before date.

date-time

Filter campaigns with start_at on or after date.

date-time

Filter by start_at date (inclusive).

date-time

Filter campaigns with end_at on or before date.

date-time

Filter campaigns with end_at on or after date.

date-time

Filter by end_at date (exclusive).

string
enum

Apply this to any method that supports sorting.

Allowed:
string
enum

Control order direction.

Allowed:
string

A CSV of unique term IDs to filter by.

string

A CSV of unique platform IDs to filter by.

string

Keyword values to search for on campaigns.

string

Keyword values to search for on campaign titles.

boolean

Filter campaigns with or without dates.

string

Filter campaigns if they are unassigned, assigned or both.

string

A CSV of user IDs to filter campaigns that are assigned to those users.

date

Filter posts with production workflow ending at or after this date.

date

Filter posts with production workflow starting at or before this date

string

Includes related items in the response (Preview).

Responses

Retry-After header

500

Internal server error

Updated over 2 years ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago