GET api/CampaignEvent?sessionId={sessionId}&campaignId={campaignId}&offset={offset}&limit={limit}&includeClosed={includeClosed}

Gets all campaign events for campaign

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionId

string

Required

campaignId

integer

Required

offset

integer

Default value is 0

limit

integer

Default value is 0

includeClosed

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of APICampaignEvent
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

CampaignId

Unique identifier of campaign to which this belongs

integer

None.

State

Status: Active, Closed or Suspended

string

None.

Name

Name of campaign event

string

None.

DefaultConversionValue

Default conversion value assigned

decimal number

None.

DefaultEventPrice

Default event price assigned

decimal number

None.

VastEvent

Denotes event used within vast adverts

boolean

None.

UnmatchedTreatment

Denotes how event should be treated if it does not match a previous click: TreatAsUnmatched, TreatAsCountOnly, TreatAsCountAndConversionOnly or TreatAsMatched

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "campaignId": 2,
    "state": "sample string 3",
    "name": "sample string 4",
    "defaultConversionValue": 1.1,
    "defaultEventPrice": 1.1,
    "vastEvent": true,
    "unmatchedTreatment": "sample string 5"
  },
  {
    "id": 1,
    "campaignId": 2,
    "state": "sample string 3",
    "name": "sample string 4",
    "defaultConversionValue": 1.1,
    "defaultEventPrice": 1.1,
    "vastEvent": true,
    "unmatchedTreatment": "sample string 5"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPICampaignEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APICampaignEvent>
    <CampaignId>2</CampaignId>
    <DefaultConversionValue>1.1</DefaultConversionValue>
    <DefaultEventPrice>1.1</DefaultEventPrice>
    <Id>1</Id>
    <Name>sample string 4</Name>
    <State>sample string 3</State>
    <UnmatchedTreatment>sample string 5</UnmatchedTreatment>
    <VastEvent>true</VastEvent>
  </APICampaignEvent>
  <APICampaignEvent>
    <CampaignId>2</CampaignId>
    <DefaultConversionValue>1.1</DefaultConversionValue>
    <DefaultEventPrice>1.1</DefaultEventPrice>
    <Id>1</Id>
    <Name>sample string 4</Name>
    <State>sample string 3</State>
    <UnmatchedTreatment>sample string 5</UnmatchedTreatment>
    <VastEvent>true</VastEvent>
  </APICampaignEvent>
</ArrayOfAPICampaignEvent>