Webhooks

Estimate A Saved Search'S Daily Volume

Changed on

Returns how many records a saved search matched per day over the last 7 days, and what they would cost. Use it to size max_events_per_day: a cap below avg_records_per_day means the webhook will drop matches every day, and dropped matches are never sent later. A webhook whose events are companies (a company search, or trigger_once_per_company) has no daily estimate and returns nulls with an unavailable_reason.

get/v0/webhooks/volume-estimate

Request

  • Base URL
    https://api.theirstack.com
  • URL
    https://api.theirstack.com/v0/webhooks/volume-estimate
  • Auth
    HTTP bearer

Query parameters

search_idinteger required

ID of the saved search to estimate

Example:123
trigger_once_per_companyboolean

Whether the webhook fires once per company. A webhook that does has no daily estimate, because its events are companies rather than jobs and it only fires for companies it has not sent yet.

Response

Successful Response

search_idinteger required

The saved search this estimate is for.

records_last_7_daysinteger nullable

Records matching the search that we discovered in the last 7 days. When the search's own date filters reach back fewer days (e.g. posted in the last 24 hours), it is measured over that shorter window and scaled to 7 days. Null when the estimate is unavailable.

avg_records_per_dayinteger nullable

records_last_7_days / 7, rounded down. The number to compare a daily cap against. Null when the estimate is unavailable.

credits_per_recordinteger required

API credits one event costs: 1 for jobs, 3 for companies.

avg_credits_per_dayinteger nullable

avg_records_per_day * credits_per_record. Null when the estimate is unavailable.

unavailable_reasonstring nullable

Why there is no estimate, when there is none. Null when there is.

Changes