Search Campaigns

This action allows you to search for a campaign or multiple campaigns matching one or more fields.

You can find the API details here.

Options:

• Result Set (dropdown): First matching campaign or All matching campaigns

Inputs:

• Search
  • Order By (string): e.g. created_at, end_at, start_at, title, updated_at
  • Order Direction (string): Control order direction, asc or desc
  • Limit (number): Default to 100, limit the number of paginated results
  • Offset (number): A 0-based offset to adjust the pagination window
  • Keywords (string): Keyword values to search for on campaigns
  • Extend Scopes? (boolean): Default to false, whether to look inside any child scopes in addition to the supplied ones
  • Team IDs (string): A CSV of license IDs to filter by
  • Campaign IDs (string): A CSV of unique IDs to filter by
  • Title (string): Keyword values to search for on campaign titles
  • Has Dates? (string): true or false, filter campaigns with or without dates
  • Access Scopes (string): Filter objects owned by the scope itself and/or shared from other scopes
  • Start At From (string): Filter campaigns with start_at on or after date, e.g. 2020-02-02
  • End At To (string): Filter campaigns with end_at on or before date, e.g. 2020-02-02
  • Start At Range From (string): inclusive, e.g. 2020-02-02. Note: Need to specify both bounds of start_at_range or not at all
  • Start At Range To (string): exclusive, e.g. 2020-02-02. Note: Need to specify both bounds of start_at_range or not at all
  • End At Range From (string): inclusive, e.g. 2020-02-02. Note: Need to specify both bounds of end_at_range or not at all
  • End At Range To (string): exclusive, e.g. 2020-02-02. Note: Need to specify both bounds of end_at_range or not at all
  • Term IDs (string): A CSV of unique term IDs to filter by
  • Platform IDs (dropdown): no_workflow, incomplete, approved or rejected
  • Approval Workflow Participant User IDs (string): A CSV of user IDs to filter by workflows where a user is a participant
  • Approval Workflow Participant Feedbacks (dropdown): pending, approved, or rejected, required when using Approval Workflow Participant User IDs
  • Approval Workflow Participant In Step (dropdown): current or any, required when using Approval Workflow Participant User IDs
  • Assignee IDs (string): A CSV of user IDs to filter campaigns that are assigned to those users
  • Assignment Statuses (string): Filter campaigns if they are unassigned, assigned or both
  • Production Workflow From Date (string): Filter campaigns with production workflow ending at or after this date, e.g. 2020-02-02
  • Production Workflow To Date (string): Filter campaigns with production workflow starting at or before this date, e.g. 2020-02-02

Outputs:

Will return either a single campaign or a list of campaigns depending on the ‘Result Set’ selection in the options.

• Campaign
  • Campaign ID (string): The unique campaign ID
  • Team ID (string): A license ID
  • Title (string): The campaign title
  • Description (string): A short description of the campaign
  • Start At (string): The date when the campaign is scheduled to start, e.g. 2019-01-01
  • End At (string): The date when the campaign is scheduled to end, e.g. 2020-01-01
  • Budget Currency (string): Standard currencies defined by ISO_4217
  • Budget Amount (string): Budget Currency and Budget Amount must be specified together if you want to provide budget info
  • Term IDs (string): An array of the terms associated with the campaign
  • Assignee ID (string): The ID of user who is assigned to the campaign
  • Created At (string): An absolute datetime indicating when this resource was created
  • Updated At (string): An absolute datetime indicating when this resource was last modified
  • Ordinal (string): Default ordering of the task relative to others with the same subject
  • Parent ID (string): The unique campaign ID
  • Root ID (string): The unique campaign ID
  • Platform IDs (collection): An array of the platforms associated with the campaign
  • Post Workflow IDs (collection): An array of the production workflows associated with the campaign
  • Production Workflow ID (string): ID of the production workflow that the campaign is attached to
  • Production Workflow IDs (collection): An array of the production workflows associated with the campaign
  • Thumbnail Asset ID (string): An asset ID, a legacy video ID or a legacy image ID
  • Topic IDs (collection): An array of the topics associated with the campaign
  • Approval IDs (collection): An array of approval IDs