Get Bulk Check Status and Results
get_bulk_checkRetrieve status, counts, and paginated per-domain results for a bulk domain check, including compact scores, grades, providers, policies, and technologies.
Instructions
Status, counts and one page of per-domain results for a bulk check started by this caller. Results are compact summaries (score, grade, providers, policies, technologies). For email checks spfPolicy and dmarcPolicy can also be missing (no record) or unknown (the lookup failed, an SPF redirect= target's lookup failed, or a subdomain's own _dmarc lookup failed), dmarcPolicy invalid (a record without a valid policy), and mxProvider unknown (the MX lookup failed) or 'null MX (no mail)'. Free.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| jobId | Yes | Job id returned by start_bulk_check (job_ followed by 24 hex characters). | |
| limit | No | Results per page. | |
| offset | No | Index of the first result to return. | |
| status | No | Only return items in this state, e.g. failed. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| check | Yes | ||
| items | Yes | ||
| jobId | Yes | ||
| counts | Yes | ||
| status | Yes | ||
| billing | Yes | ||
| accepted | Yes | ||
| createdAt | Yes | ||
| startedAt | Yes | ||
| submitted | Yes | ||
| finishedAt | Yes | ||
| nextOffset | Yes | Pass as offset to fetch the next page; null when this is the last page. | |
| creditsCharged | Yes | Prepaid credits charged up front; failed and cancelled items are refunded when the job finishes. | |
| creditsRefunded | Yes | ||
| creditsPerDomain | Yes | ||
| quotaUnitsCharged | Yes | Daily-quota units charged up front for plan keys; refunded like credits. | |
| quotaUnitsRefunded | Yes |