Avid PubSuite Partner API
  1. Campaigns
Avid PubSuite Partner API
  • Default module
    • Pubsuite API Introduction
    • Getting Started
      • Authentication
      • Response Format
      • Error Codes
      • Usage Limits
    • Endpoints
      • Endpoints / Resources Introduction
      • Global Pubsuite Reference Libaries
      • Workspace Org
        • Workspace Organisation
      • Workspace Organisation Users
        • List Users
        • User Details
        • Upsert User
        • Delete User
      • Advertiser Accounts
        • Advertiser Accounts List
        • Account Detail
        • Account Delete
        • Account Create
        • Account Update
      • Advertiser Account Members
        • Advertiser Account Members
        • Adv Account Member Detail
        • Account Delete
        • Advertiser Account Member Create
        • Account Update
      • Campaigns
        • Campaign Body Parameters
        • Campaigns
          GET
        • Campaign
          POST
        • Delete Campaign
          DELETE
        • Campaign Details
          GET
        • Update Campaign
          POST
      • Phases
        • Phase Body Parameters
        • Phases List
        • Phase
        • Phase Detail
        • Delete Phase
        • Phase Update
      • Content
        • Content Body Parameters
        • Contents
        • Content Detail
        • Create Content
        • Delete Content
        • Update Content
      • Distributions
        • Distribution Body Parameters
        • Distributions List
        • Create Distributions
        • Delete Distribution
        • Distribution Details
        • Distribution Update
      • Publisher Profiles
        • Coming Soon
        • Publisher Profiles
        • Publisher Profile
        • Delete Publisher Profile
      • Publisher Products
        • Coming Soon
      • Data Sources
        • Coming Soon
      • Webhooks
        • Services
        • Create/Update Service
        • Registered Webhooks
        • Create Webhook
        • Update Webhook
        • Delete Webhook
    • Outbound Events
      • Outbound Events
  • Commercial - Avid Webhook - Order Events
    • post_campaign_status
      • Receive Avid campaign (Adpoint Order) status updated event
    • post_content_status
      • Receive content status (Adpoint Ad Group) updated event updated event
    • Schemas
      • post_campaign_status_request
      • post_content_status_request
      • 200_post_campaign_status_response
      • 200_post_content_status_response
      • error_response
      • error
  1. Campaigns

Campaigns

Testing
GET
https://api.avidpubsuite.com/v2/campaigns
Retrieves a list of campaigns associated with the authenticated workspace for the provided API key

Request

Authorization
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
Header Params

Responses

🟢200Success
application/json
Body

Example
{
    "success": true,
    "message": "string",
    "data": {
        "campaigns": {
            "current_page": 0,
            "data": [
                {
                    "is_reporting_campaign": 0,
                    "primary_advertiser_account_id": "string",
                    "campaign_title": "string",
                    "brand_promoting": "string",
                    "campaign_status": 0,
                    "campaign_description": "string",
                    "campaign_objective": "string",
                    "no_content_pieces": 0,
                    "earliest_start_date": "2019-08-24",
                    "latest_start_date": "2019-08-24",
                    "earliest_end_date": "2019-08-24",
                    "latest_end_date": "2019-08-24",
                    "actual_start_date": "2019-08-24",
                    "campaign_net_cost": 0,
                    "tracking_report_info": "string",
                    "using_utm_tracking": 0,
                    "utm_info": "string",
                    "mandatory_donts": "string",
                    "additonal_campaign_notes": "string",
                    "campaign_target_audience_summary": "string",
                    "advertiser_primary_campaign_manager_id": 0,
                    "brief_type": "string",
                    "content_messaging_hierarchy": null,
                    "mandatory_dos": "string",
                    "content_look_feel_requests": "string",
                    "media_plan_external_url": "string",
                    "rate_card_external_url": "string",
                    "potential_up_sell_opportunities": "string",
                    "sourcing_imagery": 0,
                    "brand_logo_inclusion": null,
                    "billing_company_name": "string",
                    "billing_company_address": "string",
                    "billing_contact_person": "string",
                    "billing_contact_email": "string",
                    "billing_contact_phone": "string",
                    "purchase_order_number": "string",
                    "add_additional_content_focus_points": null,
                    "campaign_gross_cost": 0,
                    "g_impressions": 0,
                    "e_impressions": 0,
                    "g_article_views": 0,
                    "e_article_views": 0,
                    "g_clicks_to_site": 0,
                    "e_clicks_to_site": 0,
                    "g_video_views": 0,
                    "e_video_views": 0,
                    "deleted_at": "string",
                    "created_at": "string",
                    "updated_at": "string",
                    "default_advertiser": "string",
                    "brand_industry_id": 0,
                    "brand_sub_industry_id": 0,
                    "crm_deal_link": "string",
                    "advertiser_primary_commercial_manager_id": null,
                    "advertiser_access": true,
                    "content_plan": true,
                    "workflow_builder": true,
                    "forecaster": true,
                    "skip_client_content_approvals": true,
                    "allow_pubsuite_amp_to_select_segments": 0
                }
            ],
            "from": 0,
            "next_page_url": null,
            "per_page": 0,
            "prev_page_url": null,
            "to": 0
        }
    }
}
🟠401Unauthorized
Previous
Campaign Body Parameters
Next
Campaign