Skip to content

Latest commit

 

History

History
332 lines (299 loc) · 13.1 KB

community.missing_collection.checkly_check_results_info_module.rst

File metadata and controls

332 lines (299 loc) · 13.1 KB
Raw

community.missing_collection.checkly_check_results_info

Get information from checkly about Check Results.

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.
check_id
string / required
check id for checkly.
check_result_id
string
check result id for checkly when get_one_result.
check_type
string
    Choices:
  • BROWSER
  • API ←
check type for checkly.
from_date
string
unix epoch from date to filter results.
check example for format or use to_datetime filter.
get_all_results
boolean / required
    Choices:
  • no ←
  • yes
get all check results for given check_id.
get_one_result
boolean / required
    Choices:
  • no ←
  • yes
get one check result for given check_id and check_result_id.
has_failures
boolean / required
    Choices:
  • no ←
  • yes
check result has one or more failures.
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:
checkly api.

Examples

- name: get all check results detail from checkly
  community.missing_collection.checkly_check_results_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') }}"
    get_all_results: true

- name: get one check result detail from checkly
  community.missing_collection.checkly_check_results_info:
    api_key: '95e3814891ef433298150a539750076e'
    check_id: '1ceaff6c-12ce-4322-9ac1-2dd2c14a2967'
    check_result_id: 'c826dca7-6543-4649-ad47-ade94367f5b1'
    get_one_result: true

Return Values

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

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

Sample:
[{'id': 'string', 'name': 'string', 'checkId': 'string', 'hasFailures': True, 'hasErrors': True, 'isDegraded': True, 'overMaxResponseTime': True, 'runLocation': 'string', 'startedAt': '2019-08-24T14:15:22Z', 'stoppedAt': '2019-08-24T14:15:22Z', 'created_at': '2019-08-24T14:15:22Z', 'responseTime': 0, 'apiCheckResult': {}, 'browserCheckResult': {}, 'checkRunId': 0, 'attempts': 0}]


Status

Authors