Get Campaigns

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authorization

Either 1) x-token, or 2) x-api-key must be given to authenticate account.

Parameters

filter_by_grid_status

  • show_live
  • hide_from_grid
  • featured
  • show_upcoming
  • show_live_expired
  • show_upcoming_expired

filter_by_tags

  • string of tag being searched

filter_by_app_type

  • contest
  • gallery
  • sport
  • quiz
  • poll
  • instant
  • award
  • proform

filter_by_app_type

  • graded (For use with quiz app_type only)
  • outcome (For use with quiz app_type only)
  • poll (For use with poll app_type only)
  • survey (For use with poll app_type only)

filter_by_schedule_status

  • live
  • upcoming
  • expired
  • recently_expired
  • unscheduled

sort_by

  • app_id
  • sort
  • start_time
  • end_time
  • title
  • created_at

fields
Default:
app_id,account,parent_app_id,type,title,subtitle,share_title,tags,start_time,end_time,grid_status,schedule_status,primary_image,mobile_image,grid_image,display_image,prize,sort,grid_redirect,page_url

Available fields:

  • app_id
  • app_type
  • account
  • form_id
  • type
  • vcreative_prf_id
  • parent_app_id
  • syndication_type
  • title
  • subtitle
  • grid_title
  • description
  • grid_status
  • schedule_status
  • facebook_page_id
  • facebook_app_id
  • page_url
  • primary_image
  • secondary_image
  • tertiary_image
  • mobile_image
  • grid_image
  • facebook_share_image
  • display_image
  • theme_color
  • secondary_color
  • tertiary_color
  • width
  • height
  • content_box_left
  • content_box_top
  • content_box_width
  • content_box_height
  • css
  • terms
  • short_terms
  • prize
  • send_confirmation_email
  • share_location
  • share_title
  • share_subtitle
  • share_twitter
  • share_value
  • sort
  • installed_on_facebook
  • redirect_on_mobile
  • tags
  • grid_redirect
  • privacy_policy_url
  • terms_of_service_url
  • fine_print
  • custom_terms
  • hide_terms
  • additional_terms
  • language
  • notifications_email
  • test_email
  • external_id
  • whitelabel
  • archived_at
  • active
  • start_time
  • end_time
  • created_at
  • deleted_at
  • updated_at
  • time_zone

created_after
Default: The Unix Epoch (1970-01-01)
Not inclusive: created_at > created_after

created_before
Default: Tomorrow
Not inclusive: created_at < created_before

updated_after
Default: The Unix Epoch (1970-01-01)
Not inclusive: updated_at > updated_after

updated_before
Default: Tomorrow
Not inclusive: updated_at < updated_before

Path Params
string
required

Account ID

Query Params
boolean
Defaults to true

When true, returns apps that match their assigned grid status

string

Comma separated values. Returns only apps with matching grid status.

string

Comma separated list of app types to return

string

Comma separated list of app sub-types

string

Only return campaigns that have a tag that matches all or part of the given param.

string
Defaults to live,upcoming

Comma separated statuses. Returns matching apps.

boolean
Defaults to true

Converts app's start / end times to Account timezone

boolean
Defaults to true

When true, replaces shortcodes with account values.

string
Defaults to sort

Sort apps by specified criteria

string
Defaults to asc

Used with sort_by, to set direction. Can be 'asc' or 'desc'

boolean
Defaults to true

When true, ensures absolute image URLs are returned

string

Comma separated list of app fields to return

date

Only return campaigns created after this date. (Not inclusive: created_at > created_after)

date

Only return campaigns created before this date. (Not inclusive: created_at < created_before)

date

Only return campaigns updated after this date. (Not inclusive: updated_at > updated_after)

date

Only return campaigns updated before this date. (Not inclusive: updated_at < updated_before)

Headers
string

Admin's authorization token

string

Authorized account's API key

Response

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