Skip to content

Latest commit

 

History

History
234 lines (201 loc) · 8.96 KB

community.missing_collection.checkly_reporting_info_module.rst

File metadata and controls

234 lines (201 loc) · 8.96 KB

community.missing_collection.checkly_reporting_info

Generates a report with aggregate statistics for checks and check groups.

Version added: 0.3.0

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • requests

Parameters

Parameter Choices/Defaults Comments
api_key
string / required
api key for checkly.
deactivated
boolean / required
    Choices:
  • no ←
  • yes
Filter checks by activated status.
filter_by_tags
list
Default:
[]
Use tags to filter the checks you want to see in your report.
from_date
string
unix epoch from date to filter results.
Setting a custom from_date timestamp overrides the use of any preset_window.
check example for format or use to_datetime filter.
preset_window
string
    Choices:
  • last24Hrs ←
  • last7Days
  • last30Days
  • thisWeek
  • thisMonth
  • lastWeek
  • lastMonth
Preset reporting windows are used for quickly generating report on commonly used windows.
Can be overridden by using a custom to_date and from_date timestamp.
to_date
string
unix epoch to date to filter results.
Setting a custom to_date timestamp overrides the use of any preset_window.
check example for format or use to_datetime filter.
url
string
Default:
checkly api.

Examples

- name: generate report for last 24 hours
  community.missing_collection.checkly_reporting_info:
    api_key: '95e3814891ef433298150a539750076e'
    preset_window: 'last24Hrs'

- name: generate report for specific period
  community.missing_collection.checkly_reporting_info:
    api_key: '95e3814891ef433298150a539750076e'
    from_date: "{{ ('2021-09-02 06:50:00'|to_datetime).strftime('%s') }}"
    to_date: "{{ ('2021-09-04 06:50:00'|to_datetime).strftime('%s') }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
result
list
when success.
result of the api.

Sample:
[{'name': 'string', 'checkId': 'string', 'checkType': 'string', 'deactivated': True, 'tags': ['string'], 'aggregate': {'successRatio': 0, 'avg': 0, 'p95': 0, 'p99': 0}}]


Status

Authors