Response Format - Webz.io

A search response is a JSON object: a records array plus paging and account fields.

json

{
  "records": [ ... ],
  "totalResults": 1230,
  "moreResultsAvailable": 1130,
  "next": "/breaches?token=YOUR_TOKEN&email_domain=example.com&next=CURSOR",
  "requestsLeft": 989,
  "totalResultsVerified": true
}

Root fields

Field	Type	Description
`records`	array	Matching records - see Record Data Fields. Up to 100 per page.
`totalResults`	integer	Total records matching the query.
`moreResultsAvailable`	integer	Records still available after this page.
`next`	string	Relative URL of the next page, or `null` at a boundary. Append it to `https://api.webz.io` - see Pagination.
`requestsLeft`	integer	Your remaining search credit balance. `null` for internal integration tokens.
`totalResultsVerified`	boolean	`true` when historical data for the searched domains is fully indexed, so `totalResults` is exact. `false` while backfilling is still in progress.

A search response is a JSON object: a records array plus paging and account fields.

json

{
  "records": [ ... ],
  "totalResults": 1230,
  "moreResultsAvailable": 1130,
  "next": "/breaches?token=YOUR_TOKEN&email_domain=example.com&next=CURSOR",
  "requestsLeft": 989,
  "totalResultsVerified": true
}

Root fields

Field	Type	Description
`records`	array	Matching records - see Record Data Fields. Up to 100 per page.
`totalResults`	integer	Total records matching the query.
`moreResultsAvailable`	integer	Records still available after this page.
`next`	string	Relative URL of the next page, or `null` at a boundary. Append it to `https://api.webz.io` - see Pagination.
`requestsLeft`	integer	Your remaining search credit balance. `null` for internal integration tokens.
`totalResultsVerified`	boolean	`true` when historical data for the searched domains is fully indexed, so `totalResults` is exact. `false` while backfilling is still in progress.