Safe Haskell	None
Language	Haskell2010

Network.PagerDuty.REST.Reports

Contents

Alerts Per Time
Incidents Per Time
Types

Description

Access high level reports about alerts and incidents. Useful for creating graphs.

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

Synopsis

Alerts Per Time

alertsPerTime Source #

Arguments

:: UTCTime	`rSince`
-> UTCTime	`rUntil`
-> Request Report s AlertTotals

Get high level statistics about the number of alerts (SMSes, phone calls and emails) sent for the desired time period, summed daily, weekly or monthly.

GET /reports/alerts_per_time

See: http://developer.pagerduty.com/documentation/rest/reports/alerts_per_time

Incidents Per Time

incidentsPerTime Source #

Arguments

:: UTCTime	`rSince`
-> UTCTime	`rUntil`
-> Request Report s [IncidentReport]

Get high level statistics about the number of incidents created for the desired time period, summed daily, weekly or monthly.

GET /reports/incidents_per_time

See: http://developer.pagerduty.com/documentation/rest/reports/incidents_per_time

Types

data Report Source #

Instances

Eq Report Source #
Methods (==) :: Report -> Report -> Bool # (/=) :: Report -> Report -> Bool #
Show Report Source #
Methods showsPrec :: Int -> Report -> ShowS # show :: Report -> String # showList :: [Report] -> ShowS #
ToJSON Report Source #
Methods toJSON :: Report -> Value # toEncoding :: Report -> Encoding # toJSONList :: [Report] -> Value # toEncodingList :: [Report] -> Encoding #
Generic Report Source #
Associated Types type Code Report :: [[*]] # Methods from :: Report -> Rep Report # to :: Rep Report -> Report #
HasDatatypeInfo Report Source #
Methods datatypeInfo :: proxy Report -> DatatypeInfo (Code Report) #
QueryLike Report Source #
Methods toQuery :: Report -> Query #
type Code Report Source #
type Code Report

rSince :: Lens' (Request Report s b) UTCTime Source #

Start of the date range over which you want to search. The time element is optional.

rUntil :: Lens' (Request Report s b) UTCTime Source #

The end of the date range over which you want to search. This should be in the same format as since.

rRollup :: Lens' (Request Report s b) Rollup Source #

Specifies the bucket duration for each summation.

Default: monthly.

Example: A time window of two years (based on since and until) with a rollup of monthly will result in 24 sets of data points being returned (one for each month in the span).

data Rollup Source #

Constructors

Daily
Weekly
Monthly

Instances

Eq Rollup Source #
Methods (==) :: Rollup -> Rollup -> Bool # (/=) :: Rollup -> Rollup -> Bool #
Show Rollup Source #
Methods showsPrec :: Int -> Rollup -> ShowS # show :: Rollup -> String # showList :: [Rollup] -> ShowS #
ToJSON Rollup Source #
Methods toJSON :: Rollup -> Value # toEncoding :: Rollup -> Encoding # toJSONList :: [Rollup] -> Value # toEncodingList :: [Rollup] -> Encoding #
FromJSON Rollup Source #
Methods parseJSON :: Value -> Parser Rollup # parseJSONList :: Value -> Parser [Rollup] #

data AlertReport Source #

Instances

Eq AlertReport Source #
Methods (==) :: AlertReport -> AlertReport -> Bool # (/=) :: AlertReport -> AlertReport -> Bool #
Show AlertReport Source #
Methods showsPrec :: Int -> AlertReport -> ShowS # show :: AlertReport -> String # showList :: [AlertReport] -> ShowS #
ToJSON AlertReport Source #
Methods toJSON :: AlertReport -> Value # toEncoding :: AlertReport -> Encoding # toJSONList :: [AlertReport] -> Value # toEncodingList :: [AlertReport] -> Encoding #
FromJSON AlertReport Source #
Methods parseJSON :: Value -> Parser AlertReport # parseJSONList :: Value -> Parser [AlertReport] #

arStart :: Lens' AlertReport UTCTime Source #

arEnd :: Lens' AlertReport UTCTime Source #

arNumberOfAlerts :: Lens' AlertReport Int Source #

arNumberOfPhoneAlerts :: Lens' AlertReport Int Source #

arNumberOfSmsAlerts :: Lens' AlertReport Int Source #

arNumberOfEmailAlerts :: Lens' AlertReport Int Source #

data AlertTotals Source #

Instances

Eq AlertTotals Source #
Methods (==) :: AlertTotals -> AlertTotals -> Bool # (/=) :: AlertTotals -> AlertTotals -> Bool #
Show AlertTotals Source #
Methods showsPrec :: Int -> AlertTotals -> ShowS # show :: AlertTotals -> String # showList :: [AlertTotals] -> ShowS #
ToJSON AlertTotals Source #
Methods toJSON :: AlertTotals -> Value # toEncoding :: AlertTotals -> Encoding # toJSONList :: [AlertTotals] -> Value # toEncodingList :: [AlertTotals] -> Encoding #
FromJSON AlertTotals Source #
Methods parseJSON :: Value -> Parser AlertTotals # parseJSONList :: Value -> Parser [AlertTotals] #

atAlerts :: Lens' AlertTotals [AlertReport] Source #

atTotalNumberOfAlerts :: Lens' AlertTotals Int Source #

atTotalNumberOfPhoneAlerts :: Lens' AlertTotals Int Source #

atTotalNumberOfSmsAlerts :: Lens' AlertTotals Int Source #

atTotalNumberOfEmailAlerts :: Lens' AlertTotals Int Source #

atTotalNumberOfBillableAlerts :: Lens' AlertTotals Int Source #

data IncidentReport Source #

Instances

Eq IncidentReport Source #
Methods (==) :: IncidentReport -> IncidentReport -> Bool # (/=) :: IncidentReport -> IncidentReport -> Bool #
Show IncidentReport Source #
Methods showsPrec :: Int -> IncidentReport -> ShowS # show :: IncidentReport -> String # showList :: [IncidentReport] -> ShowS #
ToJSON IncidentReport Source #
Methods toJSON :: IncidentReport -> Value # toEncoding :: IncidentReport -> Encoding # toJSONList :: [IncidentReport] -> Value # toEncodingList :: [IncidentReport] -> Encoding #
FromJSON IncidentReport Source #
Methods parseJSON :: Value -> Parser IncidentReport # parseJSONList :: Value -> Parser [IncidentReport] #

irStart :: Lens' IncidentReport UTCTime Source #

irEnd :: Lens' IncidentReport UTCTime Source #

irNumberOfIncidents :: Lens' IncidentReport Int Source #