> ## Documentation Index > Fetch the complete documentation index at: https://checkly-422f444a-mda-troubleshooting-section.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Lists all check results > [DEPRECATED] This endpoint will be removed soon. Please use the `GET /v2/check-results/{checkId}` endpoint instead. Lists the full, raw check results for a specific check. We keep raw results for 30 days. After 30 days they are erased. However, we keep the rolled up results for an indefinite period. You can filter by check type and result type to narrow down the list. Use the `to` and `from` parameters to specify a date range (UNIX timestamp in seconds). Depending on the check type, some fields might be null. This endpoint will return data within a 6-hour timeframe. If the `from` and `to` params are set, they must be at most six hours apart. If none are set, we will consider the `to` param to be now and the `from` param to be six hours earlier. If only the `to` param is set we will set `from` to be six hours earlier. On the contrary, if only the `from` param is set we will consider the `to` param to be six hours later. Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most. ## OpenAPI ````yaml get /v1/check-results/{checkId} openapi: 3.0.0 info: title: Checkly Public API version: v1 description: >- These are the docs for the newly released Checkly Public API.
If you have any questions, please do not hesitate to get in touch with us. servers: - url: https://api.checklyhq.com security: - Bearer: [] tags: [] paths: /v1/check-results/{checkId}: get: tags: - Check results summary: Lists all check results description: >- [DEPRECATED] This endpoint will be removed soon. Please use the `GET /v2/check-results/{checkId}` endpoint instead. Lists the full, raw check results for a specific check. We keep raw results for 30 days. After 30 days they are erased. However, we keep the rolled up results for an indefinite period. You can filter by check type and result type to narrow down the list. Use the `to` and `from` parameters to specify a date range (UNIX timestamp in seconds). Depending on the check type, some fields might be null. This endpoint will return data within a 6-hour timeframe. If the `from` and `to` params are set, they must be at most six hours apart. If none are set, we will consider the `to` param to be now and the `from` param to be six hours earlier. If only the `to` param is set we will set `from` to be six hours earlier. On the contrary, if only the `from` param is set we will consider the `to` param to be six hours later. Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most. operationId: getV1CheckresultsCheckid parameters: - name: x-checkly-account in: header schema: type: string description: >- Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general x-format: guid: true description: >- Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general - name: checkId in: path schema: type: string x-format: guid: true required: true - name: limit in: query schema: type: integer description: Limit the number of results default: 10 minimum: 1 maximum: 100 description: Limit the number of results - name: page in: query schema: type: number description: Page number default: 1 x-constraint: sign: positive description: Page number - name: from in: query schema: type: string format: date description: >- Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours. description: >- Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours. - name: to in: query schema: type: string format: date description: >- Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after "from". description: >- Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after "from". - name: location in: query schema: type: string description: >- Provide a data center location, e.g. "eu-west-1" to filter by location enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - ca-central-1 - sa-east-1 - eu-west-1 - eu-central-1 - eu-west-2 - eu-west-3 - eu-north-1 - eu-south-1 - me-south-1 - ap-southeast-1 - ap-northeast-1 - ap-east-1 - ap-southeast-2 - ap-southeast-3 - ap-northeast-2 - ap-northeast-3 - ap-south-1 - af-south-1 description: >- Provide a data center location, e.g. "eu-west-1" to filter by location - name: checkType in: query schema: type: string description: The type of the check enum: - API - BROWSER - HEARTBEAT - ICMP - MULTI_STEP - TCP - PLAYWRIGHT - URL - DNS description: The type of the check - name: hasFailures in: query schema: type: boolean description: Check result has one or more failures description: Check result has one or more failures - name: resultType in: query schema: type: string description: The check result type (FINAL,ATTEMPT,ALL) default: FINAL enum: - FINAL - ATTEMPT - ALL description: The check result type (FINAL,ATTEMPT,ALL) responses: '200': description: Successful content: application/json: schema: $ref: '#/components/schemas/CheckResultList' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '402': description: Payment Required content: application/json: schema: $ref: '#/components/schemas/PaymentRequiredError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsError' deprecated: true components: schemas: CheckResultList: type: array items: $ref: '#/components/schemas/CheckResult' UnauthorizedError: type: object properties: statusCode: type: number enum: - 401 error: $ref: '#/components/schemas/error' message: type: string example: Bad Token attributes: $ref: '#/components/schemas/attributes' required: - statusCode - error PaymentRequiredError: type: object properties: statusCode: type: number enum: - 402 error: $ref: '#/components/schemas/Model7' message: type: string example: Payment Required attributes: $ref: '#/components/schemas/attributes' required: - statusCode - error ForbiddenError: type: object properties: statusCode: type: number enum: - 403 error: $ref: '#/components/schemas/Model4' message: type: string example: Forbidden required: - statusCode - error TooManyRequestsError: type: object properties: statusCode: type: number enum: - 429 error: $ref: '#/components/schemas/Model5' message: type: string example: Too Many Requests attributes: $ref: '#/components/schemas/attributes' required: - statusCode - error CheckResult: type: object properties: id: type: string description: The unique ID of this result. name: type: string description: The name of the check. checkId: type: string description: The ID of the check. hasFailures: type: boolean description: >- Describes if any failure has occurred during this check run. This is should be your mainmain focus for assessing API or browser check behaviour. Assertions that fail, timeouts or failing scripts all resolve tothis value being true. hasErrors: type: boolean description: >- Describes if an internal error has occured in Checkly's backend. This should be false in almost all cases. isDegraded: type: boolean description: >- A check is degraded if it is over the degradation limit set by the "degradedResponseTime" field on the check. Applies only to API checks. nullable: true overMaxResponseTime: type: boolean description: >- Set to true if the response time is over the limit set by the "maxResponseTime" field on the check. Applies only to API checks. nullable: true runLocation: type: string description: What data center location this check result originated from. startedAt: type: string format: date-time nullable: true stoppedAt: type: string format: date-time nullable: true created_at: type: string format: date-time responseTime: type: number description: >- Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this. apiCheckResult: $ref: '#/components/schemas/CheckResultAPI' browserCheckResult: $ref: '#/components/schemas/CheckResultBrowser' multiStepCheckResult: $ref: '#/components/schemas/MultiStepResultBrowser' checkRunId: type: number description: The id of the specific check run that created this check result. attempts: type: number description: >- How often this check was retried. This will be larger than 0 when double checking is enabled. resultType: $ref: '#/components/schemas/resultType' sequenceId: type: string description: >- The sequence ID of the check run. This is used to group check runs with multiple attempts together. example: 2dbfa2a3-5477-45ea-ac33-ee55b8ea66ff nullable: true x-format: guid: true required: - resultType error: type: string enum: - Unauthorized attributes: type: object Model7: type: string enum: - Payment Required Model4: type: string enum: - Forbidden Model5: type: string enum: - Too Many Requests CheckResultAPI: type: object description: The response data for an API check. nullable: true properties: assertions: $ref: '#/components/schemas/assertions' request: $ref: '#/components/schemas/request' response: $ref: '#/components/schemas/response' requestError: type: string description: Describes if an error occurred on the request. example: 'null' nullable: true jobLog: $ref: '#/components/schemas/jobLog' jobAssets: $ref: '#/components/schemas/jobAssets' pcapDataUrl: type: string description: Packet capture data if available as redirect/download URL. nullable: true CheckResultBrowser: type: object description: The response data for a browser check. example: 'null' nullable: true properties: type: type: string description: The type of framework the check is using. example: PLAYWRIGHT traceSummary: $ref: '#/components/schemas/traceSummary' pages: $ref: '#/components/schemas/pages' playwrightTestVideos: $ref: '#/components/schemas/playwrightTestVideos' errors: $ref: '#/components/schemas/errors' endTime: type: number description: End time of the check run. example: 1648573423995 startTime: type: number description: Start time of the check run. example: 1648573423994 runtimeVersion: type: string description: Active runtime version. example: '2023.09' jobLog: $ref: '#/components/schemas/Model44' jobAssets: $ref: '#/components/schemas/jobAssets' playwrightTestTraces: $ref: '#/components/schemas/playwrightTestTraces' playwrightTestJsonReportFile: type: string description: Playwright Test JSON report. example: >- https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json MultiStepResultBrowser: type: object description: The response data for a multi-step check. example: 'null' nullable: true properties: errors: $ref: '#/components/schemas/errors' endTime: type: number description: End time of the check run. example: 1648573423995 startTime: type: number description: Start time of the check run. example: 1648573423994 runtimeVersion: type: string description: Active runtime version. example: '2023.09' jobLog: $ref: '#/components/schemas/Model45' jobAssets: $ref: '#/components/schemas/jobAssets' playwrightTestTraces: $ref: '#/components/schemas/playwrightTestTraces' playwrightTestJsonReportFile: type: string description: Playwright Test JSON report. example: >- https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json resultType: type: string description: >- The type of result. FINAL means this is the final result of the check run. ATTEMPT means this is a result of a double check attempt. example: FINAL default: FINAL enum: - FINAL - ATTEMPT - ALL assertions: type: array description: List of API check assertions. example: - source: STATUS_CODE target: 200 nullable: true items: type: string request: type: object description: The request for the API. properties: method: type: string example: GET url: type: string example: https://api.checklyhq.com data: type: string example: '' headers: $ref: '#/components/schemas/headers' params: $ref: '#/components/schemas/params' response: type: object description: The API response. properties: status: type: number example: 200 statusText: type: string example: OK body: type: string example: Checkly Public API headers: $ref: '#/components/schemas/headers' timings: $ref: '#/components/schemas/timings' timingPhases: $ref: '#/components/schemas/timingPhases' jobLog: type: object description: Check run log results. nullable: true jobAssets: type: array description: Assets generated from the check run. example: 'null' nullable: true items: type: string traceSummary: type: object description: The summary of errors in the check run. pages: type: array description: List of pages used on the check run. example: - url: https://www.checklyhq.com/ webVitals: CLS: score: GOOD value: 0.000146484375 items: type: string playwrightTestVideos: type: array description: List of Playwright Test videos. example: - >- https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot-1675691043856.webm items: type: string errors: type: array description: List of errors on the check run. example: [] items: type: string Model44: type: array description: Check run log results. example: time: 1648573423995 msg: Starting job level: DEBUG nullable: true items: type: string playwrightTestTraces: type: array description: List of Playwright Test traces. example: - >- https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot.zip items: type: string Model45: type: array description: Check run log results. example: time: 1648573423995 msg: Starting job level: DEBUG nullable: true items: type: string headers: type: object params: type: object timings: type: object timingPhases: type: object securitySchemes: Bearer: type: http scheme: bearer bearerFormat: Bearer description: >- The Checkly Public API uses API keys to authenticate requests. You can get the API Key [here](https://app.checklyhq.com/settings/user/api-keys). Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set **Authorization** header while using cURL: `curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"` ````