List all campaigns

Returns a list of the campaigns for your account, sorted by program Id.

Parameters


Name optional

Name of the program.


State optional

State of the program.

View possible enum values
ACTIVEProgram is currently active.
AWAITING_REVIEWProgram is awaiting review by impact.com.
CANCELLEDProgram was cancelled before it began.
CLOSEDProgram was closed by impact.com.
DEACTIVATEDProgram was deactivated by an account user.
DELINQUENTProgram is past due on payments to either impact.com or its partner(s).
REJECTEDProgram was rejected by impact.com.
SETUPProgram is getting set up and will be available soon.
SETUP_COMPLETEProgram is set up and is awaiting approval.

Returns


Returns an array of campaign objects up to a limit dictated by @pagesize. Each entry in the array is a separate program. If no programs meet the criteria, the resulting array will be empty. This request should never return an error.

Example Request


curl 'https://api.impact.com/Advertisers/<AccountSID>/Campaigns' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'Name=Acme%20Campaign' \
  -d 'State=ACTIVE' \
  -G

Example Response


{
  "@page": "1",
  ...
  "Campaigns": [
    {
      "Id": "1000",
      "Name": "Acme Campaign",
      "State": "ACTIVE",
      "Categories": {
        "PrimaryCategory": "B2B, Services & Office Supplies",
        "PrimarySubCategories": [
          "B2B"
        ],
        "AdditionalCategory": "",
        "AdditionalSubCategories": []
        },
      "ShortDescription": "This is a short description.",
      "LongDescription": "This is a long description. Find more words here.",
      "ListInMarketplace": "true",
      "DisplayServicingAgency": "false",
      "Rating": "3",
      "SearchKeywords": "Anvils",
      "ShippingRegions": [
        "United States"
      ],
      "Resources": {
        "CompanyHomepage": "www.acme.com",
        "ExampleLandingPage": "",
        "InformationPage": "",
        "AdditionalRelatedLinks": []
      },
      "CompanyContacts": [
        {
          "FirstName": "Brand",
          "LastName": "Man",
          "EmailAddress": "[email protected]",
          "PhoneNumber": "+1(805) 123-1234"
        }
      ],
      "GiftCardPayouts": "false",
      "TrademarkBidding": "false",
      "ThirdPartyImpressionPixel": "",
      "MobileReadyAds": "false",
      "DisplayFutureAds": "false",
      "PromoCodeTracking": "true",
      "TrackingDomain": "acme.sjv.io",
      "SiteDefinition": "www.acme.com",
      "ImpressionTracking": "false",
      "ViewThroughCrediting": "false",
      "IdentityMatching": "IR_CONSORTIUM",
      "GatewayTrackingSettings": {
        "DefaultLandingPage": "http://www.acme.com",
        "MediaPartnerTrackingTemplate": "",
        "CampaignTrackingTemplate": "",
        "SSLSupport": "true",
        "DeepLinking": "true",
        "DeepLinkDomains": "acme.com/store/forge/anvils/anvil2",
        "ThirdPartyGatewayUrl": "",
        "ThirdPartyGatewayQueryStringParameters": "",
        "UniqueClickWindowLength": "30m",
        "UniqueClickWindowType": "ROLLING"
        },
      "DirectTrackingSettings": {
        "UnidentifiedName": "",
        "SessionWindowLength": ""
        },
      "Uri": "/Advertisers/<AccountSID>/Campaigns/1000"
    }
  ]
}