Skip to main content
POST
Search volume

Authorizations

X-API-KEY
string
header
required

Body

application/json
query
object
required

Provide at least one of text, texts or filters.

group_by
enum<string>[]

Break the volume down by where the matching documents come from. Any combination of source, tier. package also supported for enterprise users on unit-based consumption model.

Minimum array length: 1
Available options:
source,
tier,
package
Example:

Response

200 - application/json

Volume search results

results
object
required

Volume statistics aggregated by date and totals.

usage
Query Units · object
required

API usage for the request. Shape depends on the account consumption model.

metadata
object

Request metadata and timing information.