Network.PagerDuty.REST.LogEntries

PagerDuty keeps a log of all the events that happen to an incident. The following APIs provide fine-grained access to this incident log entry data to give you more insight into how your team or organization is handling your incidents. Log entry data includes details about the event(s) that triggered the incident, who was notified and when, how they were notified, and who acknowledged or resolved it, amongst a few other things.

See: http://developer.pagerduty.com/documentation/rest/log_entries

List Logs

data ListLogs

Instances

Eq ListLogs

Methods

(==) :: ListLogs -> ListLogs -> Bool

(/=) :: ListLogs -> ListLogs -> Bool

Show ListLogs

Methods

showsPrec :: Int -> ListLogs -> ShowS

show :: ListLogs -> String

showList :: [ListLogs] -> ShowS

ToJSON ListLogs

Methods

toJSON :: ListLogs -> Value

toEncoding :: ListLogs -> Encoding

toJSONList :: [ListLogs] -> Value

toEncodingList :: [ListLogs] -> Encoding

Generic ListLogs

Associated Types

type Code ListLogs :: [[*]]

Methods

from :: ListLogs -> Rep ListLogs

to :: Rep ListLogs -> ListLogs

HasDatatypeInfo ListLogs

Methods

datatypeInfo :: proxy ListLogs -> DatatypeInfo (Code ListLogs)

QueryLike ListLogs

Methods

toQuery :: ListLogs -> Query

Paginate ListLogs

Methods

next :: Request ListLogs s b -> Maybe Pager -> Maybe (Request ListLogs s b)

type Code ListLogs

type Code ListLogs

listLogs :: Request ListLogs s [LogEntry]

List all incident log entries across the entire account.

GET /log_entries

See: http://developer.pagerduty.com/documentation/rest/log_entries/list

listUserLogs :: UserId -> Request ListLogs s [LogEntry]

List all incident log entries that describe interactions with a specific user.

GET /users/:user_id/log_entries

See: http://developer.pagerduty.com/documentation/rest/log_entries/user_log_entries

listIncidentLogs :: IncidentKey -> Request ListLogs s [LogEntry]

List all incident log entries for a specific incident.

GET /incidents/:incident_id/log_entries

See: http://developer.pagerduty.com/documentation/rest/log_entries/incident_log_entries

llTimeZone :: Lens' (Request ListLogs s b) TimeZone

Time zone in which dates in the result will be rendered.

Default: UTC.

llSince :: Lens' (Request ListLogs s b) (Maybe UTCTime)

The start of the date range over which you want to search.

llUntil :: Lens' (Request ListLogs s b) (Maybe UTCTime)

The end of the date range over which you want to search.

llIsOverview :: Lens' (Request ListLogs s b) Bool

If true, will only return log entries of type trigger, acknowlldge, or resolve.

Default: false.

Get Log

data GetLog

Instances

Eq GetLog

Methods

(==) :: GetLog -> GetLog -> Bool

(/=) :: GetLog -> GetLog -> Bool

Show GetLog

Methods

showsPrec :: Int -> GetLog -> ShowS

show :: GetLog -> String

showList :: [GetLog] -> ShowS

ToJSON GetLog

Methods

toJSON :: GetLog -> Value

toEncoding :: GetLog -> Encoding

toJSONList :: [GetLog] -> Value

toEncodingList :: [GetLog] -> Encoding

Generic GetLog

Associated Types

type Code GetLog :: [[*]]

Methods

from :: GetLog -> Rep GetLog

to :: Rep GetLog -> GetLog

HasDatatypeInfo GetLog

Methods

datatypeInfo :: proxy GetLog -> DatatypeInfo (Code GetLog)

QueryLike GetLog

Methods

toQuery :: GetLog -> Query

type Code GetLog

type Code GetLog

getLog :: LogEntryId -> Request GetLog s LogEntry

Get details for a specific incident log entry. This method provides additional information you can use to get at raw event data.

GET /log_entries/:id

See: http://developer.pagerduty.com/documentation/rest/log_entries/show

glTimeZone :: Lens' (Request GetLog s b) TimeZone

Time zone in which dates in the result will be rendered.

Default: UTC.

Types

Channels

data Channel

Representation of the means by which the action was channeled.

Constructors

ChanNagios NagiosChannel

ChanAPI APIChannel

ChanEmail EmailChannel

ChanUserEmail User EmailChannel

ChanWebTrigger User WebTriggerChannel

ChanSMS User

ChanWeb User

ChanNote User

ChanAuto

ChanTimeout

Instances

Eq Channel

Methods

(==) :: Channel -> Channel -> Bool

(/=) :: Channel -> Channel -> Bool

Show Channel

Methods

showsPrec :: Int -> Channel -> ShowS

show :: Channel -> String

showList :: [Channel] -> ShowS

FromJSON Channel

Methods

parseJSON :: Value -> Parser Channel

parseJSONList :: Value -> Parser [Channel]

_ChanNagios :: Prism' Channel NagiosChannel

_ChanAPI :: Prism' Channel APIChannel

_ChanEmail :: Prism' Channel EmailChannel

_ChanUserEmail :: Prism' Channel (User, EmailChannel)

_ChanWebTrigger :: Prism' Channel (User, WebTriggerChannel)

_ChanSMS :: Prism' Channel User

_ChanWeb :: Prism' Channel User

_ChanNote :: Prism' Channel User

_ChanAuto :: Prism' Channel ()

_ChanTimeout :: Prism' Channel ()

data NagiosChannel

Instances

Eq NagiosChannel

Methods

(==) :: NagiosChannel -> NagiosChannel -> Bool

(/=) :: NagiosChannel -> NagiosChannel -> Bool

Show NagiosChannel

Methods

showsPrec :: Int -> NagiosChannel -> ShowS

show :: NagiosChannel -> String

showList :: [NagiosChannel] -> ShowS

ToJSON NagiosChannel

Methods

toJSON :: NagiosChannel -> Value

toEncoding :: NagiosChannel -> Encoding

toJSONList :: [NagiosChannel] -> Value

toEncodingList :: [NagiosChannel] -> Encoding

FromJSON NagiosChannel

Methods

parseJSON :: Value -> Parser NagiosChannel

parseJSONList :: Value -> Parser [NagiosChannel]

ncSummary :: Lens' NagiosChannel Text

Same as host.

ncHost :: Lens' NagiosChannel Text

Nagios host.

ncService :: Lens' NagiosChannel (Maybe Text)

Nagios service that created the event, if applicable.

ncState :: Lens' NagiosChannel Text

State the caused the event.

ncDetails :: Lens' NagiosChannel Object

Additional details of the incident.

data APIChannel

Instances

Eq APIChannel

Methods

(==) :: APIChannel -> APIChannel -> Bool

(/=) :: APIChannel -> APIChannel -> Bool

Show APIChannel

Methods

showsPrec :: Int -> APIChannel -> ShowS

show :: APIChannel -> String

showList :: [APIChannel] -> ShowS

ToJSON APIChannel

Methods

toJSON :: APIChannel -> Value

toEncoding :: APIChannel -> Encoding

toJSONList :: [APIChannel] -> Value

toEncodingList :: [APIChannel] -> Encoding

FromJSON APIChannel

Methods

parseJSON :: Value -> Parser APIChannel

parseJSONList :: Value -> Parser [APIChannel]

acSummary :: Lens' APIChannel Text

Same as description.

acServiceKey :: Lens' APIChannel ServiceKey

API service key.

acDescription :: Lens' APIChannel Text

Description of the event.

acIncidentKey :: Lens' APIChannel IncidentKey

Incident deduping string.

acDetails :: Lens' APIChannel Object

Additional details of the incident, if any.

data EmailType

Constructors

Plain

HTML

Instances

Eq EmailType

Methods

(==) :: EmailType -> EmailType -> Bool

(/=) :: EmailType -> EmailType -> Bool

Show EmailType

Methods

showsPrec :: Int -> EmailType -> ShowS

show :: EmailType -> String

showList :: [EmailType] -> ShowS

ToJSON EmailType

Methods

toJSON :: EmailType -> Value

toEncoding :: EmailType -> Encoding

toJSONList :: [EmailType] -> Value

toEncodingList :: [EmailType] -> Encoding

FromJSON EmailType

Methods

parseJSON :: Value -> Parser EmailType

parseJSONList :: Value -> Parser [EmailType]

data EmailChannel

Instances

Eq EmailChannel

Methods

(==) :: EmailChannel -> EmailChannel -> Bool

(/=) :: EmailChannel -> EmailChannel -> Bool

Show EmailChannel

Methods

showsPrec :: Int -> EmailChannel -> ShowS

show :: EmailChannel -> String

showList :: [EmailChannel] -> ShowS

ToJSON EmailChannel

Methods

toJSON :: EmailChannel -> Value

toEncoding :: EmailChannel -> Encoding

toJSONList :: [EmailChannel] -> Value

toEncodingList :: [EmailChannel] -> Encoding

FromJSON EmailChannel

Methods

parseJSON :: Value -> Parser EmailChannel

parseJSONList :: Value -> Parser [EmailChannel]

ecSummary :: Lens' EmailChannel Text

Same as subject.

ecTo :: Lens' EmailChannel Text

To address of the email.

ecFrom :: Lens' EmailChannel Text

From address of the email.

ecSubject :: Lens' EmailChannel Text

Subject of the email.

ecBody :: Lens' EmailChannel Text

Body of the email.

ecBodyContentType :: Lens' EmailChannel EmailType

Content type of the email body.

ecRawUrl :: Lens' EmailChannel Text

URL for raw text of email.

ecHtmlUrl :: Lens' EmailChannel (Maybe Text)

URL for html rendered version of the email.

Only present if content_type is HTML.

data WebTriggerChannel

Instances

Eq WebTriggerChannel

Methods

(==) :: WebTriggerChannel -> WebTriggerChannel -> Bool

(/=) :: WebTriggerChannel -> WebTriggerChannel -> Bool

Show WebTriggerChannel

Methods

showsPrec :: Int -> WebTriggerChannel -> ShowS

show :: WebTriggerChannel -> String

showList :: [WebTriggerChannel] -> ShowS

ToJSON WebTriggerChannel

Methods

toJSON :: WebTriggerChannel -> Value

toEncoding :: WebTriggerChannel -> Encoding

toJSONList :: [WebTriggerChannel] -> Value

toEncodingList :: [WebTriggerChannel] -> Encoding

FromJSON WebTriggerChannel

Methods

parseJSON :: Value -> Parser WebTriggerChannel

parseJSONList :: Value -> Parser [WebTriggerChannel]

wcSummary :: Lens' WebTriggerChannel Text

Same as subject.

wcSubject :: Lens' WebTriggerChannel Text

Subject of the web trigger.

wcDetails :: Lens' WebTriggerChannel (Maybe Text)

Details about the web trigger.

Entries

data Entry

Constructors

LogEntry LogEntry

Log entries come in a wide variety of types. Most types use this format, the exception being the NotifyEntry type.

NotifyEntry NotifyEntry

A user was notified.

Instances

Eq Entry

Methods

(==) :: Entry -> Entry -> Bool

(/=) :: Entry -> Entry -> Bool

Show Entry

Methods

showsPrec :: Int -> Entry -> ShowS

show :: Entry -> String

showList :: [Entry] -> ShowS

_LogEntry :: Prism' Entry LogEntry

_NotifyEntry :: Prism' Entry NotifyEntry

data LogEntryType

Constructors

Trigger

The incident was triggered.

Acknowledge

The incident was acknowledged.

Unacknowledge

The incident was unacknowledged.

Resolve

The incident was resolved.

Escalate

The incident was escalated.

Assign

The incident was assigned to a user.

Annotate

A note was added to the incident.

ReachTriggerLimit

The incident has reached the log entry trigger limit and will not create any more.

RepeatEscalationPath

The incident has reached the end of its escalation policy and will restart.

ExhaustEscalationPath

The incident has cycled through its escalation policy the max allowed number of times.

Notify

A user was notified.

Instances

Eq LogEntryType

Methods

(==) :: LogEntryType -> LogEntryType -> Bool

(/=) :: LogEntryType -> LogEntryType -> Bool

Show LogEntryType

Methods

showsPrec :: Int -> LogEntryType -> ShowS

show :: LogEntryType -> String

showList :: [LogEntryType] -> ShowS

ToJSON LogEntryType

Methods

toJSON :: LogEntryType -> Value

toEncoding :: LogEntryType -> Encoding

toJSONList :: [LogEntryType] -> Value

toEncodingList :: [LogEntryType] -> Encoding

FromJSON LogEntryType

Methods

parseJSON :: Value -> Parser LogEntryType

parseJSONList :: Value -> Parser [LogEntryType]

data LogEntry

The raw log event.

Instances

Eq LogEntry

Methods

(==) :: LogEntry -> LogEntry -> Bool

(/=) :: LogEntry -> LogEntry -> Bool

Show LogEntry

Methods

showsPrec :: Int -> LogEntry -> ShowS

show :: LogEntry -> String

showList :: [LogEntry] -> ShowS

FromJSON LogEntry

Methods

parseJSON :: Value -> Parser LogEntry

parseJSONList :: Value -> Parser [LogEntry]

leId :: Lens' LogEntry LogEntryId

Id of the log entry.

leType :: Lens' LogEntry LogEntryType

The type of the log entry.

leCreatedAt :: Lens' LogEntry Date

Time at which the log entry was created.

leNote :: Lens' LogEntry (Maybe Text)

Optional field containing an action note, if one was included with the action.

leAssignedUser :: Lens' LogEntry (Maybe User)

Only for assign, escalate log entries. The user to which the incident is assigned.

leChannel :: Lens' LogEntry Channel

Representation of the means by which the action was channeled and the possible perfomer of this action.

data NotifyEntry

Notify log entries correspond to notifications sent to users. They have a distinct format from action log entries.

Instances

Eq NotifyEntry

Methods

(==) :: NotifyEntry -> NotifyEntry -> Bool

(/=) :: NotifyEntry -> NotifyEntry -> Bool

Show NotifyEntry

Methods

showsPrec :: Int -> NotifyEntry -> ShowS

show :: NotifyEntry -> String

showList :: [NotifyEntry] -> ShowS

ToJSON NotifyEntry

Methods

toJSON :: NotifyEntry -> Value

toEncoding :: NotifyEntry -> Encoding

toJSONList :: [NotifyEntry] -> Value

toEncodingList :: [NotifyEntry] -> Encoding

FromJSON NotifyEntry

Methods

parseJSON :: Value -> Parser NotifyEntry

parseJSONList :: Value -> Parser [NotifyEntry]

neCreatedAt :: Lens' NotifyEntry UTCTime

Time at which the log entry was created

neUser :: Lens' NotifyEntry User

User who was notified

neNotification :: Lens' NotifyEntry Notification

Object representing the notification itself

data NotificationType

Constructors

SMS

Email

Phone

IosPushNotification

Instances

Eq NotificationType

Methods

(==) :: NotificationType -> NotificationType -> Bool

(/=) :: NotificationType -> NotificationType -> Bool

Show NotificationType

Methods

showsPrec :: Int -> NotificationType -> ShowS

show :: NotificationType -> String

showList :: [NotificationType] -> ShowS

ToJSON NotificationType

Methods

toJSON :: NotificationType -> Value

toEncoding :: NotificationType -> Encoding

toJSONList :: [NotificationType] -> Value

toEncodingList :: [NotificationType] -> Encoding

FromJSON NotificationType

Methods

parseJSON :: Value -> Parser NotificationType

parseJSONList :: Value -> Parser [NotificationType]

data NotificationStatus

Constructors

Success

Blocked

Busy

Failed

NoAnswer

BadAddress

Instances

Eq NotificationStatus

Methods

(==) :: NotificationStatus -> NotificationStatus -> Bool

(/=) :: NotificationStatus -> NotificationStatus -> Bool

Show NotificationStatus

Methods

showsPrec :: Int -> NotificationStatus -> ShowS

show :: NotificationStatus -> String

showList :: [NotificationStatus] -> ShowS

ToJSON NotificationStatus

Methods

toJSON :: NotificationStatus -> Value

toEncoding :: NotificationStatus -> Encoding

toJSONList :: [NotificationStatus] -> Value

toEncodingList :: [NotificationStatus] -> Encoding

FromJSON NotificationStatus

Methods

parseJSON :: Value -> Parser NotificationStatus

parseJSONList :: Value -> Parser [NotificationStatus]

data Notification

Instances

Eq Notification

Methods

(==) :: Notification -> Notification -> Bool

(/=) :: Notification -> Notification -> Bool

Show Notification

Methods

showsPrec :: Int -> Notification -> ShowS

show :: Notification -> String

showList :: [Notification] -> ShowS

ToJSON Notification

Methods

toJSON :: Notification -> Value

toEncoding :: Notification -> Encoding

toJSONList :: [Notification] -> Value

toEncodingList :: [Notification] -> Encoding

FromJSON Notification

Methods

parseJSON :: Value -> Parser Notification

parseJSONList :: Value -> Parser [Notification]

nType :: Lens' Notification NotificationType

Type of notification.

nStatus :: Lens' Notification NotificationStatus

The current status of the notification.

nAddress :: Lens' Notification Address

The address to which the notification was sent. I.e., an email address, phone number, or iPhone name.