community.missing_collection.checkly_check_results_rolled_up_info_module.rst

community.missing_collection.checkly_check_results_rolled_up_info

Get information from checkly about Check Results (Rolled Up).

Version added: 0.3.0

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Get information from checkly about Check Results (Rolled Up).
• https://www.checklyhq.com/docs/api#tag/Check-results-(rolled-up)

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.
check_id string / required		check id for checkly.
from_date string		unix epoch from date to filter results. check example for format or use to_datetime filter.
limit integer	Default: 100	number of results from checkly per call.
location string		filter results with given location only. example ap-south-1
page integer		page number if there are results more than given limit in a call.
to_date string		unix epoch to date to filter results. check example for format or use to_datetime filter.
url string	Default: "https://api.checklyhq.com/v1/check-results-rolled-up/"	checkly api.

Examples

- name: get check results (rolled up) detail from checkly
  community.missing_collection.checkly_check_results_rolled_up_info:
    api_key: '95e3814891ef433298150a539750076e'
    check_id: '1ceaff6c-12ce-4322-9ac1-2dd2c14a2967'
    page: 1
    from_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: [{'checkId': '1ceaff6c-12ce-4322-9ac1-2dd2c14a2967', 'errorCount': 0, 'failureCount': 0, 'hour': '2021-09-04T07:00:00.000Z', 'responseTimes': [75], 'resultsCount': 1, 'runLocation': 'us-east-2'}]

Status

Authors

• Davinder Pal (@116davinder) <dpsangwal@gmail.com>