GET api/MonitorHistory?systemName={systemName}&username={username}&password={password}&monitorId={monitorId}&relatedId={relatedId}&offset={offset}&limit={limit}

Read all monitor histories

Request Information

URI Parameters

NameDescriptionTypeAdditional information
systemName

string

Required

username

string

Required

password

string

Required

monitorId

integer

Required

relatedId

integer

Default value is 0

offset

integer

Default value is 0

limit

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of APIMonitorHistory
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

MonitorId

Unique identifier of monitor to which this relates

integer

None.

Timestamp

Timestamp

string

None.

RelatedId

Unique identifier of provider, feed, advertiser, campaign, publisher or site to which this relates

integer

None.

CurrentAverage

Current average

decimal number

None.

CurrentAverageCount

Current average count

integer

None.

HistoricAverage

Historic average

decimal number

None.

HistoricAverageCount

Historic average count

integer

None.

Percentage

Percentage change

decimal number

None.

DisplayState

Indicates if latest value is reaches or exceeds display threshold

string

None.

DisplayStateTimestamp

Timestamp when display threshold acquired current state

string

None.

DisplayStateCount

Number of periods for which display threshold has been in current state

integer

None.

EmailState

Indicates if latest value is reaches or exceeds email threshold

string

None.

EmailStateTimestamp

Timestamp when email threshold acquired current state

string

None.

EmailStateCount

Number of periods for which email threshold has been in current state

integer

None.

EmailStateNotify

Denotes that email notification should be sent

boolean

None.

EmailStateNotified

Denotes that email notification has been sent

boolean

None.

SMSState

Indicates if latest value is reaches or exceeds sms threshold

string

None.

SMSStateTimestamp

Timestamp when sms threshold acquired current state

string

None.

SMSStateCount

Number of periods for which sms threshold has been in current state

integer

None.

SMSStateNotify

Denotes that sms notification should be sent

boolean

None.

SMSStateNotified

Denotes that sms notification has been sent

boolean

None.

CancelReminders

Denotes that reminders are temporarily cancelled

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "monitorId": 2,
    "timestamp": "sample string 3",
    "relatedId": 4,
    "currentAverage": 1.1,
    "currentAverageCount": 1,
    "historicAverage": 1.1,
    "historicAverageCount": 1,
    "percentage": 1.1,
    "displayState": "sample string 5",
    "displayStateTimestamp": "sample string 6",
    "displayStateCount": 1,
    "emailState": "sample string 7",
    "emailStateTimestamp": "sample string 8",
    "emailStateCount": 1,
    "emailStateNotify": true,
    "emailStateNotified": true,
    "smsState": "sample string 9",
    "smsStateTimestamp": "sample string 10",
    "smsStateCount": 1,
    "smsStateNotify": true,
    "smsStateNotified": true,
    "cancelReminders": true
  },
  {
    "id": 1,
    "monitorId": 2,
    "timestamp": "sample string 3",
    "relatedId": 4,
    "currentAverage": 1.1,
    "currentAverageCount": 1,
    "historicAverage": 1.1,
    "historicAverageCount": 1,
    "percentage": 1.1,
    "displayState": "sample string 5",
    "displayStateTimestamp": "sample string 6",
    "displayStateCount": 1,
    "emailState": "sample string 7",
    "emailStateTimestamp": "sample string 8",
    "emailStateCount": 1,
    "emailStateNotify": true,
    "emailStateNotified": true,
    "smsState": "sample string 9",
    "smsStateTimestamp": "sample string 10",
    "smsStateCount": 1,
    "smsStateNotify": true,
    "smsStateNotified": true,
    "cancelReminders": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPIMonitorHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APIMonitorHistory>
    <CancelReminders>true</CancelReminders>
    <CurrentAverage>1.1</CurrentAverage>
    <CurrentAverageCount>1</CurrentAverageCount>
    <DisplayState>sample string 5</DisplayState>
    <DisplayStateCount>1</DisplayStateCount>
    <DisplayStateTimestamp>sample string 6</DisplayStateTimestamp>
    <EmailState>sample string 7</EmailState>
    <EmailStateCount>1</EmailStateCount>
    <EmailStateNotified>true</EmailStateNotified>
    <EmailStateNotify>true</EmailStateNotify>
    <EmailStateTimestamp>sample string 8</EmailStateTimestamp>
    <HistoricAverage>1.1</HistoricAverage>
    <HistoricAverageCount>1</HistoricAverageCount>
    <Id>1</Id>
    <MonitorId>2</MonitorId>
    <Percentage>1.1</Percentage>
    <RelatedId>4</RelatedId>
    <SMSState>sample string 9</SMSState>
    <SMSStateCount>1</SMSStateCount>
    <SMSStateNotified>true</SMSStateNotified>
    <SMSStateNotify>true</SMSStateNotify>
    <SMSStateTimestamp>sample string 10</SMSStateTimestamp>
    <Timestamp>sample string 3</Timestamp>
  </APIMonitorHistory>
  <APIMonitorHistory>
    <CancelReminders>true</CancelReminders>
    <CurrentAverage>1.1</CurrentAverage>
    <CurrentAverageCount>1</CurrentAverageCount>
    <DisplayState>sample string 5</DisplayState>
    <DisplayStateCount>1</DisplayStateCount>
    <DisplayStateTimestamp>sample string 6</DisplayStateTimestamp>
    <EmailState>sample string 7</EmailState>
    <EmailStateCount>1</EmailStateCount>
    <EmailStateNotified>true</EmailStateNotified>
    <EmailStateNotify>true</EmailStateNotify>
    <EmailStateTimestamp>sample string 8</EmailStateTimestamp>
    <HistoricAverage>1.1</HistoricAverage>
    <HistoricAverageCount>1</HistoricAverageCount>
    <Id>1</Id>
    <MonitorId>2</MonitorId>
    <Percentage>1.1</Percentage>
    <RelatedId>4</RelatedId>
    <SMSState>sample string 9</SMSState>
    <SMSStateCount>1</SMSStateCount>
    <SMSStateNotified>true</SMSStateNotified>
    <SMSStateNotify>true</SMSStateNotify>
    <SMSStateTimestamp>sample string 10</SMSStateTimestamp>
    <Timestamp>sample string 3</Timestamp>
  </APIMonitorHistory>
</ArrayOfAPIMonitorHistory>