GET api/Monitor?systemName={systemName}&username={username}&password={password}&offset={offset}&limit={limit}

Read all monitors

Request Information

URI Parameters

NameDescriptionTypeAdditional information
systemName

string

Required

username

string

Required

password

string

Required

offset

integer

Default value is 0

limit

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of APIMonitor
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

Description

Description of monitor

string

None.

Monitor

Monitor: Searches, Impressions, Clicks, Spend, AverageImpressionsPerSearch, AverageClicksPerSearch, AverageClicksPerImpression, AverageSpendPerSearch, AverageSpendPerImpression or AverageSpendPerClick

string

None.

MonitorSubset

MonitorSubset: Global, EachProvider, IncludeProviders, ExcludeProviders, EachFeed, IncludeFeeds, ExcludeFeeds, EachAdvertiser, IncludeAdvertisers, ExcludeAdvertisers, EachCampaign, IncludeCampaigns, ExcludeCampaigns, EachPublisher, IncludePublishers, ExcludePublishers, EachSite, IncludeSites or ExcludeSites

string

None.

MonitorSubsetIds

List of ids according to type specified by monitor subset

Collection of integer

None.

Timeframe

Timeframe: HourComparedWithPreviousHour, HourComparedWithDayBefore, HourComparedWithAverageOfPreviousDay, HourComparedWithWeekBefore, HourComparedWithAverageOfPreviousWeek, DayComparedWithDayBefore, DayComparedWithWeekBefore, DayComparedWithAverageOfPreviousWeek, or WeekComparedWithWeekBefore

string

None.

TimeframeSubset

Timeframe Subset: All, [For hourly:] List of hours (comma-separated), [For daily:] List of days (comma-separated)

string

None.

MinimumSearches

Minimum number of searches in previous period

integer

None.

MinimumImpressions

Minimum number of impressions in previous period

integer

None.

MinimumClicks

Minimum number of clicks in previous period

integer

None.

MinimumEvents

Minimum number of events in previous period

integer

None.

MinimumSpend

Minimum spend in previous period

decimal number

None.

DisplayIncreasePercentage

Percentage increase to trigger display

decimal number

None.

DisplayDecreasePercentage

Percentage decrease to trigger display

decimal number

None.

EmailIncreasePercentage

Percentage increase to trigger email

decimal number

None.

EmailDecreasePercentage

Percentage decrease to trigger email

decimal number

None.

SMSIncreasePercentage

Percentage increase to trigger sms

decimal number

None.

SMSDecreasePercentage

Percentage decrease to trigger sms

decimal number

None.

InitialDelay

Initial delay must be nodelay, delayby1hour, delayby2hours, delayby3hours, delayby6hours or delayby12hours for hourly timeframes or nodelay, delayby1day, delayby2days or delayby3days for daily timeframes

string

None.

ReminderFrequency

ReminderFrequency: None, Hourly, Every3Hours, Every6Hours, Every12Hours, Daily, Weekly

string

None.

AlertMessage

Message displayed or sent by either email or SMS

string

None.

AlertSuspended

Denotes that alerting is currently suspended - typically used during settings evaluation

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "description": "sample string 2",
    "monitor": "sample string 3",
    "monitorSubset": "sample string 4",
    "monitorSubsetIds": [
      1,
      2
    ],
    "timeframe": "sample string 5",
    "timeframeSubset": "sample string 6",
    "minimumSearches": 1,
    "minimumImpressions": 1,
    "minimumClicks": 1,
    "minimumEvents": 1,
    "minimumSpend": 1.1,
    "displayIncreasePercentage": 1.1,
    "displayDecreasePercentage": 1.1,
    "emailIncreasePercentage": 1.1,
    "emailDecreasePercentage": 1.1,
    "smsIncreasePercentage": 1.1,
    "smsDecreasePercentage": 1.1,
    "initialDelay": "sample string 7",
    "reminderFrequency": "sample string 8",
    "alertMessage": "sample string 9",
    "alertSuspended": true
  },
  {
    "id": 1,
    "description": "sample string 2",
    "monitor": "sample string 3",
    "monitorSubset": "sample string 4",
    "monitorSubsetIds": [
      1,
      2
    ],
    "timeframe": "sample string 5",
    "timeframeSubset": "sample string 6",
    "minimumSearches": 1,
    "minimumImpressions": 1,
    "minimumClicks": 1,
    "minimumEvents": 1,
    "minimumSpend": 1.1,
    "displayIncreasePercentage": 1.1,
    "displayDecreasePercentage": 1.1,
    "emailIncreasePercentage": 1.1,
    "emailDecreasePercentage": 1.1,
    "smsIncreasePercentage": 1.1,
    "smsDecreasePercentage": 1.1,
    "initialDelay": "sample string 7",
    "reminderFrequency": "sample string 8",
    "alertMessage": "sample string 9",
    "alertSuspended": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPIMonitor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APIMonitor>
    <AlertMessage>sample string 9</AlertMessage>
    <AlertSuspended>true</AlertSuspended>
    <Description>sample string 2</Description>
    <DisplayDecreasePercentage>1.1</DisplayDecreasePercentage>
    <DisplayIncreasePercentage>1.1</DisplayIncreasePercentage>
    <EmailDecreasePercentage>1.1</EmailDecreasePercentage>
    <EmailIncreasePercentage>1.1</EmailIncreasePercentage>
    <Id>1</Id>
    <InitialDelay>sample string 7</InitialDelay>
    <MinimumClicks>1</MinimumClicks>
    <MinimumEvents>1</MinimumEvents>
    <MinimumImpressions>1</MinimumImpressions>
    <MinimumSearches>1</MinimumSearches>
    <MinimumSpend>1.1</MinimumSpend>
    <Monitor>sample string 3</Monitor>
    <MonitorSubset>sample string 4</MonitorSubset>
    <MonitorSubsetIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </MonitorSubsetIds>
    <ReminderFrequency>sample string 8</ReminderFrequency>
    <SMSDecreasePercentage>1.1</SMSDecreasePercentage>
    <SMSIncreasePercentage>1.1</SMSIncreasePercentage>
    <Timeframe>sample string 5</Timeframe>
    <TimeframeSubset>sample string 6</TimeframeSubset>
  </APIMonitor>
  <APIMonitor>
    <AlertMessage>sample string 9</AlertMessage>
    <AlertSuspended>true</AlertSuspended>
    <Description>sample string 2</Description>
    <DisplayDecreasePercentage>1.1</DisplayDecreasePercentage>
    <DisplayIncreasePercentage>1.1</DisplayIncreasePercentage>
    <EmailDecreasePercentage>1.1</EmailDecreasePercentage>
    <EmailIncreasePercentage>1.1</EmailIncreasePercentage>
    <Id>1</Id>
    <InitialDelay>sample string 7</InitialDelay>
    <MinimumClicks>1</MinimumClicks>
    <MinimumEvents>1</MinimumEvents>
    <MinimumImpressions>1</MinimumImpressions>
    <MinimumSearches>1</MinimumSearches>
    <MinimumSpend>1.1</MinimumSpend>
    <Monitor>sample string 3</Monitor>
    <MonitorSubset>sample string 4</MonitorSubset>
    <MonitorSubsetIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </MonitorSubsetIds>
    <ReminderFrequency>sample string 8</ReminderFrequency>
    <SMSDecreasePercentage>1.1</SMSDecreasePercentage>
    <SMSIncreasePercentage>1.1</SMSIncreasePercentage>
    <Timeframe>sample string 5</Timeframe>
    <TimeframeSubset>sample string 6</TimeframeSubset>
  </APIMonitor>
</ArrayOfAPIMonitor>