POST checks/generic/{checkId}/results
Gets generic check results in json format.
URL Parameters
Name | Description |
---|---|
checkId | Check identifier. Type: numeric. |
Remarks
The default context for the route is the user context. To enable customer context (if it's allowed for the user) use the request query parameter customer_context=1.
Request example and description
curl --request POST "https://api-asm1.apica.io/v3/checks/generic/12345/results?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E" --header "Content-Type: application/json" --data-raw "{ \"filter\": { \"range\": { \"mostrecent\": 10, \"milliseconds_utc\": [ 1376980667000, 1376980667001 ], \"period\": { \"from_utc\": \"2013-08-20T13:32:08\", \"to_utc\": \"2013-08-21T13:32:08\" }, \"result_ids\": [ \"280792e3-5145-49ba-ad14-c668eea7674c\", \"ef7719e8-4a64-400a-9c80-c429b32bedbc\", \"d881ec9a-1537-4971-a502-1885fda98d87\" ] } } }"
Name | Type | Required | Description |
---|---|---|---|
filter | Object | Yes |
The filter section defines the criteria for selecting the check results. |
range | Object | Yes |
This section allows to define the aggregate range of the results by combining different filters. It must contain at least one filter. |
mostrecent | Integer | No |
Number of most recent results. |
milliseconds_utc | Array | No |
Array of timestamps associated with results. Each item is represented by a UNIX Epoch timestamp (milliseconds after 1970). |
period | Object | No |
The period section defines the date range to obtain results for. |
from_utc | DateTime | Yes |
Starting timestamp (in UTC) for the date range. |
to_utc | DateTime | Yes |
Ending timestamp (in UTC) for the date range. |
result_ids | Array | No |
Array of result identifiers to specific results. |
Response body model example and description
{ "check_id": 1, "check_results": [ { "attempts": 1, "result_code": 1, "timestamp_utc": "2024-05-19T11:03:43", "severity": "sample string 3", "value": 1, "resultId": "7d301bc8-3a21-4346-8a15-c23ce6b7f983", "result": {} }, { "attempts": 1, "result_code": 1, "timestamp_utc": "2024-05-19T11:03:43", "severity": "sample string 3", "value": 1, "resultId": "ab0dc258-a266-4ab2-8299-b36902b45be2", "result": {} }, { "attempts": 1, "result_code": 1, "timestamp_utc": "2024-05-19T11:03:43", "severity": "sample string 3", "value": 1, "resultId": "5181052d-43d0-4f7e-a36e-e20902e883d1", "result": {} } ] }
Name | Type | Description |
---|---|---|
check_id | Integer |
The check identifier. |
check_results | Array |
Check results. |
attempts | Integer |
The number of attempts. |
result_code | Integer |
The result code. |
timestamp_utc | DateTime |
The result timestamp in UTC. |
severity | String |
The result severity. |
value | Integer |
The result value. |
resultId | Guid |
The result identifier. |
result | Object |
The custom result data in json format. |