community.missing_collection.statuscake_pagespeed_info_module.rst

community.missing_collection.statuscake_pagespeed_info

Get information from Status Cake (Pagespeed).

Version added: 0.3.0

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

Synopsis

• Get information from Status Cake (Pagespeed).
• https://www.statuscake.com/api/v1/#tag/pagespeed

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 statuscake.
get_all_tests boolean	Choices: no yes	get list of all pagespeed tests.
get_one_test boolean	Choices: no yes	fetch info about one specific test id.
get_test_histroy boolean	Choices: no yes	fetch history info about one specific test id.
id string		id of pagespeed test.
url string	Default: "https://api.statuscake.com/v1/pagespeed/"	statuscake pagespeed api.

Examples

- name: get all pagespeed tests
  community.missing_collection.statuscake_pagespeed_info:
    api_key: 'Ohxxxxxxxxxxxxxxxxpi'
    get_all_tests: true
  register: __tests

- name: get info about one pagespeed test
  community.missing_collection.statuscake_pagespeed_info:
    api_key: 'Ohxxxxxxxxxxxxxxxxpi'
    get_one_test: true
    id: '{{ __tests.data[0].id }}'

- name: get history about one pagespeed test
  community.missing_collection.statuscake_pagespeed_info:
    api_key: 'Ohxxxxxxxxxxxxxxxxpi'
    get_test_histroy: true
    id: '{{ __tests.data[0].id }}'

Return Values

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

Key	Returned	Description
data dict/list	when success.	result of the api. Sample: [{'alert_bigger': 0, 'alert_slower': 0, 'alert_smaller': 0, 'check_rate': 1440, 'contact_groups': [], 'id': '88176', 'latest_stats': {'filesize_kb': 251.284, 'has_issue': False, 'latest_issue': '', 'loadtime_ms': 344, 'requests': 6}, 'location': 'PAGESPD-US4', 'location_iso': 'US', 'name': 'google_test_new', 'paused': False, 'website_url': 'https://www.google.com'}]

Status

Authors

• Davinder Pal (@116davinder) <[email protected]>