{ "error": { "code": "invalid_request", "message": "frequency: must be daily or weekly", "request_id": "req_8f2a61c09d4e7b3a5f10c2d8", "details": [ { "field": "frequency", "message": "must be daily or weekly" } ] }}
Monitoring turns a one-time search into a scheduled one. At each run, the search looks for companies that match and are not already in its results, and adds up to limit new ones. Read them from the same results endpoint, passing your last next_cursor as after.Send this request for any search that has finished, or set monitor when you start the search. Sending it again changes the frequency, or pauses and resumes the schedule.
Every run is charged like a search. The search’s max_cost_usd applies to each run. See Scheduled searches.
Example bodies
{ "frequency": "daily"}
{ "frequency": "daily", "paused": true}
Path parameters
string
required
The search’s id, returned when it was started.
Body
string
required
How often the search runs again. daily runs every 24 hours and weekly every 7 days, counted from when monitoring was turned on.
boolean
default:"false"
true keeps the schedule but skips runs until you set it back to false.
Response
200 The search, with its schedule in monitor.
string
required
company_search or people_search.
string
required
The search’s identifier. Use it to read status and results.
string
required
queued and running are in progress. completed, failed and cancelled are terminal. completed means this run finished, not that every matching record in the world was found. A monitored search goes back to running at its next scheduled run.
string | null
required
Why a finished search stopped. null while it is in progress. Can also be null on a failed search; read error.Options: target_reached, sources_exhausted, usage_limit_reached, retrieval_limit_reached, query_needs_clarification, provider_failed, cancelled.
string | null
required
A message when status is failed. Results found before the failure stay readable.
string | null
required
The natural-language request, when the search was started with query.
integer
required
The most results this search will return.
object | null
required
How a query was read. null until the query has been interpreted, and for searches started with filters or criteria.
Show properties
object
Structured conditions. A record must meet every condition in all. null is treated the same as leaving filters out. See the filter reference for every field and operator.
Show properties
object[]
required
The conditions. A record must meet every one. Each item is a field condition (field, operator, value) or a related condition.
Show item properties
string
The field to test, such as company.industry or person.title.
string
How to compare. Which operators a field accepts depends on its type.Options: in, matches, eq, gt, gte, lt, lte, between, within_last_days.
any
The value to compare against. A list for in, a two-item list for between, a {amount, currency} object for money fields, a number of days for within_last_days.
object
A condition on records related to the company. All conditions in where must be true of the same record, for example one job listing.
Show properties
string
required
open_jobs: the company has at least one open job that matches. new_hires: someone with a matching title joined the company within the window.
object
required
Conditions on the related record.
Show properties
object[]
required
Conditions on title (in), posted_at (within_last_days, for open_jobs) or started_at (within_last_days, for new_hires).
Show item properties
string
required
The field on the related record.Options: title, posted_at, started_at.
string
required
in for title; within_last_days for posted_at and started_at.
any
required
A list of titles for in, or a whole number of days from 1 to 36500 for within_last_days.
object[]
Free-text requirements read from the query.
Show item properties
string
required
The requirement, written as a statement that is true of a match.
string
attribute: a lasting fact the company’s own description could state, such as “sells to hospitals”. event: something that happened, such as “opened a location in Texas this year”; checked by web research.
string[]
Requirements no public source can confirm, quoted from the query. A search cannot run while there are any.
object[]
Problems validating the filters the query was read as. A search cannot run while there are any.
Show item properties
string
The filter path with the problem.
string
required
What is wrong.
object[]
required
Ambiguous wording in the query and how it was read.
Show item properties
string
required
The exact phrase from the query.
string
required
The reading that was used.
string[]
required
Other readings. Reword the query if one of these is what you meant.
object
required
Counts so far. They only increase.
Show properties
integer
required
Candidates checked so far.
integer
required
Candidates that matched every requirement and were added to the results.
integer
required
Candidates that failed at least one requirement.
integer
required
Candidates whose evidence could not confirm every requirement. They are not returned.
integer
required
Candidates that matched every requirement but were not returned because limit or a spend limit had already been reached.
integer
required
Contacts found so far. For company searches with persona_ids, and people searches with enrichment.
number
required
What this search has cost so far, in US dollars, including the 5% platform fee.
boolean
required
true after a cancel request, until the search reaches cancelled.
object | null
required
The schedule, when the search is monitored. null for a search that runs once. On a monitored search, status and stop_reason describe the most recent run, and progress and cost_usd are totals across all runs.
Show properties
string
required
How often the search runs again.Options: daily, weekly.
string
required
active when runs are scheduled. paused when the schedule is kept but runs are skipped.
integer
required
How many runs have finished, including the first.
string | null
required
When the most recent run finished.
string | null
required
When the next run is due. null while paused.
string
required
When the search was started.
string | null
required
When the search reached a terminal status.
string | null
required
When the search and its results stop being readable. null when no expiry is set.
string
required
The URL of this search’s status.
string
required
The URL of this search’s results.
Errors
Status
Code
When
400
invalid_request
The request is invalid, for example a frequency other than daily or weekly, or a search that was cancelled.
401
invalid_api_key
The API key is missing, invalid or revoked.
404
not_found
No such object in this workspace.
429
rate_limited
Too many requests. Retry after Retry-After seconds.
500
internal_error
Something went wrong on our side. Retry with backoff, and with the same Idempotency-Key if you sent one.
{ "error": { "code": "invalid_request", "message": "frequency: must be daily or weekly", "request_id": "req_8f2a61c09d4e7b3a5f10c2d8", "details": [ { "field": "frequency", "message": "must be daily or weekly" } ] }}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Avina Data API","description":"One API to search companies and people across B2B data providers, with evidence for every match. Documentation for the Avina Universal B2B Data API.","colors":{"primary":"#7D4CFF","light":"#B79CFF","dark":"#7D4CFF"},"logo":{"light":"https://mintcdn.com/avina-api/RKvQej-a7A7w7r8I/logo/avina-light.png?fit=max\u0026auto=format\u0026n=RKvQej-a7A7w7r8I\u0026q=85\u0026s=5f5ab43b1cc341eb8d68192209f27e96","dark":"https://mintcdn.com/avina-api/RKvQej-a7A7w7r8I/logo/avina-dark.png?fit=max\u0026auto=format\u0026n=RKvQej-a7A7w7r8I\u0026q=85\u0026s=18ee4451cdaa5192539e5935eb31f19d","href":"/"},"favicon":"https://mintcdn.com/avina-api/RKvQej-a7A7w7r8I/favicon.png?fit=max\u0026auto=format\u0026n=RKvQej-a7A7w7r8I\u0026q=85\u0026s=35b91ac4e130fa64fa9cfa7db19790bf","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["bash","python","javascript"]},"mdx":{"auth":{"method":"bearer"},"server":"https://api.avina.io/v1"}},"appearance":{"default":"dark"},"background":{"color":{"light":"#FFFFFF","dark":"#0E0E11"}},"navbar":{"links":[{"href":"/changelog","label":"Changelog"},{"href":"mailto:support@avina.io","label":"Support"}],"primary":{"type":"button","label":"Get an API key","href":"/get-access"}},"footer":{"socials":{"website":"https://avina.io"},"links":[{"header":"Data API","items":[{"label":"Request beta access","href":"/get-access"},{"label":"Quickstart","href":"/quickstart"},{"label":"API reference","href":"/api-reference/introduction"},{"label":"Build with AI","href":"/build-with-ai"}]},{"header":"Avina","items":[{"label":"Dashboard","href":"https://app.avina.io"},{"label":"Platform docs","href":"https://docs.avina.io"},{"label":"Contact","href":"mailto:support@avina.io"}]}]},"search":{"prompt":"Search the Data API docs..."},"fonts":{"family":"Geist"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":true},"contextual":{"options":["copy","view","claude","chatgpt","cursor","vscode","mcp"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"avina-api","hasAudioNarration":false,"actualSubdomain":"avina-api","customDomains":["docs.data.avina.io"],"gitSource":{"type":"artifacts","owner":"prod","repo":"6af4f6ad7ffdbd3614d37fdd","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6af4f7027a5b68b010ee03b3"},"entitlements":{},"buildId":"6afe0794b09b3388dc47f740","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"API Reference","count":27},{"language":"default","tag":"Documentation","count":24},{"language":"default","tag":"Concepts","count":7},{"language":"default","tag":"Guides","count":7},{"language":"default","tag":"Companies","count":6},{"language":"default","tag":"People","count":6},{"language":"default","tag":"Capabilities","count":6},{"language":"default","tag":"Personas","count":5},{"language":"default","tag":"Get started","count":4},{"language":"default","tag":"Coming Soon","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[]}
{"page":{"pagePath":"api-reference/companies/monitor-search","slug":"/api-reference/companies/monitor-search","pageMetadata":{"title":"Monitor a company search","sidebarTitle":"Monitor a search","description":"Runs a company search again on a schedule, so it keeps finding new companies.","api":"PUT https://api.avina.io/v1/companies/search/{search_id}/monitor","href":"/api-reference/companies/monitor-search"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Runs a company search again on a schedule, so it keeps finding new companies.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Expandable,Heading,ParamField,ResponseField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Monitoring turns a one-time search into a scheduled one. At each run, the search looks for companies that match and are not already in its results, and adds up to `,_jsx(_components.code,{children:`limit`}),` new ones. Read them from the same `,_jsx(_components.a,{href:`/api-reference/companies/list-results`,children:`results endpoint`}),`, passing your last `,_jsx(_components.code,{children:`next_cursor`}),` as `,_jsx(_components.code,{children:`after`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Send this request for any search that has finished, or set `,_jsx(_components.code,{children:`monitor`}),` when you `,_jsx(_components.a,{href:`/api-reference/companies/search`,children:`start the search`}),`. Sending it again changes the frequency, or pauses and resumes the schedule.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Every run is charged like a search. The search’s `,_jsx(_components.code,{children:`max_cost_usd`}),` applies to each run. See `,_jsx(_components.a,{href:`/guides/scheduled-searches`,children:`Scheduled searches`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`example-bodies`,children:`Example bodies`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Run daily`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"frequency\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"daily\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Pause`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"frequency\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"daily\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"paused\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`3`,id:`path-parameters`,children:`Path parameters`}),`\n`,_jsx(ParamField,{path:`search_id`,type:`string`,required:true,id:`param-search-id`,children:_jsxs(_components.p,{children:[`The search’s `,_jsx(_components.code,{children:`id`}),`, returned when it was started.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`body`,children:`Body`}),`\n`,_jsx(ParamField,{body:`frequency`,type:`string`,required:true,id:`param-frequency`,children:_jsxs(_components.p,{children:[`How often the search runs again. `,_jsx(_components.code,{children:`daily`}),` runs every 24 hours and `,_jsx(_components.code,{children:`weekly`}),` every 7 days, counted from when monitoring was turned on.`]})}),`\n`,_jsx(ParamField,{body:`paused`,type:`boolean`,default:`false`,id:`param-paused`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`true`}),` keeps the schedule but skips runs until you set it back to `,_jsx(_components.code,{children:`false`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:_jsx(_components.code,{children:`200`})}),` The search, with its schedule in `,_jsx(_components.code,{children:`monitor`}),`.`]}),`\n`,_jsx(ResponseField,{name:`object`,type:`string`,required:true,id:`param-object`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`company_search`}),` or `,_jsx(_components.code,{children:`people_search`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`The search’s identifier. Use it to read status and results.`})}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,required:true,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`queued`}),` and `,_jsx(_components.code,{children:`running`}),` are in progress. `,_jsx(_components.code,{children:`completed`}),`, `,_jsx(_components.code,{children:`failed`}),` and `,_jsx(_components.code,{children:`cancelled`}),` are terminal. `,_jsx(_components.code,{children:`completed`}),` means this run finished, not that every matching record in the world was found. A monitored search goes back to `,_jsx(_components.code,{children:`running`}),` at its next scheduled run.`]})}),`\n`,_jsxs(ResponseField,{name:`stop_reason`,type:`string | null`,required:true,id:`param-stop-reason`,children:[_jsxs(_components.p,{children:[`Why a finished search stopped. `,_jsx(_components.code,{children:`null`}),` while it is in progress. Can also be `,_jsx(_components.code,{children:`null`}),` on a `,_jsx(_components.code,{children:`failed`}),` search; read `,_jsx(_components.code,{children:`error`}),`.`]}),_jsxs(_components.p,{children:[`Options: `,_jsx(_components.code,{children:`target_reached`}),`, `,_jsx(_components.code,{children:`sources_exhausted`}),`, `,_jsx(_components.code,{children:`usage_limit_reached`}),`, `,_jsx(_components.code,{children:`retrieval_limit_reached`}),`, `,_jsx(_components.code,{children:`query_needs_clarification`}),`, `,_jsx(_components.code,{children:`provider_failed`}),`, `,_jsx(_components.code,{children:`cancelled`}),`.`]})]}),`\n`,_jsx(ResponseField,{name:`error`,type:`string | null`,required:true,id:`param-error`,children:_jsxs(_components.p,{children:[`A message when `,_jsx(_components.code,{children:`status`}),` is `,_jsx(_components.code,{children:`failed`}),`. Results found before the failure stay readable.`]})}),`\n`,_jsx(ResponseField,{name:`query`,type:`string | null`,required:true,id:`param-query`,children:_jsxs(_components.p,{children:[`The natural-language request, when the search was started with `,_jsx(_components.code,{children:`query`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`limit`,type:`integer`,required:true,id:`param-limit`,children:_jsx(_components.p,{children:`The most results this search will return.`})}),`\n`,_jsxs(ResponseField,{name:`interpretation`,type:`object | null`,required:true,id:`param-interpretation`,children:[_jsxs(_components.p,{children:[`How a `,_jsx(_components.code,{children:`query`}),` was read. `,_jsx(_components.code,{children:`null`}),` until the query has been interpreted, and for searches started with `,_jsx(_components.code,{children:`filters`}),` or `,_jsx(_components.code,{children:`criteria`}),`.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`filters`,type:`object`,id:`param-filters`,children:[_jsxs(_components.p,{children:[`Structured conditions. A record must meet every condition in `,_jsx(_components.code,{children:`all`}),`. `,_jsx(_components.code,{children:`null`}),` is treated the same as leaving `,_jsx(_components.code,{children:`filters`}),` out. See the `,_jsx(_components.a,{href:`/guides/structured-filters`,children:`filter reference`}),` for every field and operator.`]}),_jsx(Expandable,{title:`properties`,children:_jsxs(ResponseField,{name:`all`,type:`object[]`,required:true,id:`param-all`,children:[_jsxs(_components.p,{children:[`The conditions. A record must meet every one. Each item is a field condition (`,_jsx(_components.code,{children:`field`}),`, `,_jsx(_components.code,{children:`operator`}),`, `,_jsx(_components.code,{children:`value`}),`) or a `,_jsx(_components.code,{children:`related`}),` condition.`]}),_jsxs(Expandable,{title:`item properties`,children:[_jsx(ResponseField,{name:`field`,type:`string`,id:`param-field`,children:_jsxs(_components.p,{children:[`The field to test, such as `,_jsx(_components.code,{children:`company.industry`}),` or `,_jsx(_components.code,{children:`person.title`}),`.`]})}),_jsxs(ResponseField,{name:`operator`,type:`string`,id:`param-operator`,children:[_jsx(_components.p,{children:`How to compare. Which operators a field accepts depends on its type.`}),_jsxs(_components.p,{children:[`Options: `,_jsx(_components.code,{children:`in`}),`, `,_jsx(_components.code,{children:`matches`}),`, `,_jsx(_components.code,{children:`eq`}),`, `,_jsx(_components.code,{children:`gt`}),`, `,_jsx(_components.code,{children:`gte`}),`, `,_jsx(_components.code,{children:`lt`}),`, `,_jsx(_components.code,{children:`lte`}),`, `,_jsx(_components.code,{children:`between`}),`, `,_jsx(_components.code,{children:`within_last_days`}),`.`]})]}),_jsx(ResponseField,{name:`value`,type:`any`,id:`param-value`,children:_jsxs(_components.p,{children:[`The value to compare against. A list for `,_jsx(_components.code,{children:`in`}),`, a two-item list for `,_jsx(_components.code,{children:`between`}),`, a `,_jsx(_components.code,{children:`{amount, currency}`}),` object for money fields, a number of days for `,_jsx(_components.code,{children:`within_last_days`}),`.`]})}),_jsxs(ResponseField,{name:`related`,type:`object`,id:`param-related`,children:[_jsxs(_components.p,{children:[`A condition on records related to the company. All conditions in `,_jsx(_components.code,{children:`where`}),` must be true of the same record, for example one job listing.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`relationship`,type:`string`,required:true,id:`param-relationship`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`open_jobs`}),`: the company has at least one open job that matches. `,_jsx(_components.code,{children:`new_hires`}),`: someone with a matching title joined the company within the window.`]})}),_jsxs(ResponseField,{name:`where`,type:`object`,required:true,id:`param-where`,children:[_jsx(_components.p,{children:`Conditions on the related record.`}),_jsx(Expandable,{title:`properties`,children:_jsxs(ResponseField,{name:`all`,type:`object[]`,required:true,id:`param-all-1`,children:[_jsxs(_components.p,{children:[`Conditions on `,_jsx(_components.code,{children:`title`}),` (`,_jsx(_components.code,{children:`in`}),`), `,_jsx(_components.code,{children:`posted_at`}),` (`,_jsx(_components.code,{children:`within_last_days`}),`, for `,_jsx(_components.code,{children:`open_jobs`}),`) or `,_jsx(_components.code,{children:`started_at`}),` (`,_jsx(_components.code,{children:`within_last_days`}),`, for `,_jsx(_components.code,{children:`new_hires`}),`).`]}),_jsxs(Expandable,{title:`item properties`,children:[_jsxs(ResponseField,{name:`field`,type:`string`,required:true,id:`param-field-1`,children:[_jsx(_components.p,{children:`The field on the related record.`}),_jsxs(_components.p,{children:[`Options: `,_jsx(_components.code,{children:`title`}),`, `,_jsx(_components.code,{children:`posted_at`}),`, `,_jsx(_components.code,{children:`started_at`}),`.`]})]}),_jsx(ResponseField,{name:`operator`,type:`string`,required:true,id:`param-operator-1`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`in`}),` for `,_jsx(_components.code,{children:`title`}),`; `,_jsx(_components.code,{children:`within_last_days`}),` for `,_jsx(_components.code,{children:`posted_at`}),` and `,_jsx(_components.code,{children:`started_at`}),`.`]})}),_jsx(ResponseField,{name:`value`,type:`any`,required:true,id:`param-value-1`,children:_jsxs(_components.p,{children:[`A list of titles for `,_jsx(_components.code,{children:`in`}),`, or a whole number of days from 1 to 36500 for `,_jsx(_components.code,{children:`within_last_days`}),`.`]})})]})]})})]})]})]})]})]})})]}),_jsxs(ResponseField,{name:`criteria`,type:`object[]`,id:`param-criteria`,children:[_jsx(_components.p,{children:`Free-text requirements read from the query.`}),_jsxs(Expandable,{title:`item properties`,children:[_jsx(ResponseField,{name:`text`,type:`string`,required:true,id:`param-text`,children:_jsx(_components.p,{children:`The requirement, written as a statement that is true of a match.`})}),_jsx(ResponseField,{name:`kind`,type:`string`,id:`param-kind`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`attribute`}),`: a lasting fact the company’s own description could state, such as “sells to hospitals”. `,_jsx(_components.code,{children:`event`}),`: something that happened, such as “opened a location in Texas this year”; checked by web research.`]})})]})]}),_jsx(ResponseField,{name:`unsupported_criteria`,type:`string[]`,id:`param-unsupported-criteria`,children:_jsx(_components.p,{children:`Requirements no public source can confirm, quoted from the query. A search cannot run while there are any.`})}),_jsxs(ResponseField,{name:`errors`,type:`object[]`,id:`param-errors`,children:[_jsx(_components.p,{children:`Problems validating the filters the query was read as. A search cannot run while there are any.`}),_jsxs(Expandable,{title:`item properties`,children:[_jsx(ResponseField,{name:`field`,type:`string`,id:`param-field-2`,children:_jsx(_components.p,{children:`The filter path with the problem.`})}),_jsx(ResponseField,{name:`message`,type:`string`,required:true,id:`param-message`,children:_jsx(_components.p,{children:`What is wrong.`})})]})]})]})]}),`\n`,_jsxs(ResponseField,{name:`assumptions`,type:`object[]`,required:true,id:`param-assumptions`,children:[_jsx(_components.p,{children:`Ambiguous wording in the query and how it was read.`}),_jsxs(Expandable,{title:`item properties`,children:[_jsx(ResponseField,{name:`text`,type:`string`,required:true,id:`param-text-1`,children:_jsx(_components.p,{children:`The exact phrase from the query.`})}),_jsx(ResponseField,{name:`assumed`,type:`string`,required:true,id:`param-assumed`,children:_jsx(_components.p,{children:`The reading that was used.`})}),_jsx(ResponseField,{name:`alternatives`,type:`string[]`,required:true,id:`param-alternatives`,children:_jsx(_components.p,{children:`Other readings. Reword the query if one of these is what you meant.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`progress`,type:`object`,required:true,id:`param-progress`,children:[_jsx(_components.p,{children:`Counts so far. They only increase.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`candidates`,type:`integer`,required:true,id:`param-candidates`,children:_jsx(_components.p,{children:`Candidates checked so far.`})}),_jsx(ResponseField,{name:`accepted`,type:`integer`,required:true,id:`param-accepted`,children:_jsx(_components.p,{children:`Candidates that matched every requirement and were added to the results.`})}),_jsx(ResponseField,{name:`rejected`,type:`integer`,required:true,id:`param-rejected`,children:_jsx(_components.p,{children:`Candidates that failed at least one requirement.`})}),_jsx(ResponseField,{name:`unknown`,type:`integer`,required:true,id:`param-unknown`,children:_jsx(_components.p,{children:`Candidates whose evidence could not confirm every requirement. They are not returned.`})}),_jsx(ResponseField,{name:`not_returned`,type:`integer`,required:true,id:`param-not-returned`,children:_jsxs(_components.p,{children:[`Candidates that matched every requirement but were not returned because `,_jsx(_components.code,{children:`limit`}),` or a spend limit had already been reached.`]})}),_jsx(ResponseField,{name:`contacts_found`,type:`integer`,required:true,id:`param-contacts-found`,children:_jsxs(_components.p,{children:[`Contacts found so far. For company searches with `,_jsx(_components.code,{children:`persona_ids`}),`, and people searches with enrichment.`]})})]})]}),`\n`,_jsx(ResponseField,{name:`cost_usd`,type:`number`,required:true,id:`param-cost-usd`,children:_jsx(_components.p,{children:`What this search has cost so far, in US dollars, including the 5% platform fee.`})}),`\n`,_jsx(ResponseField,{name:`cancel_requested`,type:`boolean`,required:true,id:`param-cancel-requested`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`true`}),` after a cancel request, until the search reaches `,_jsx(_components.code,{children:`cancelled`}),`.`]})}),`\n`,_jsxs(ResponseField,{name:`monitor`,type:`object | null`,required:true,id:`param-monitor`,children:[_jsxs(_components.p,{children:[`The schedule, when the search is monitored. `,_jsx(_components.code,{children:`null`}),` for a search that runs once. On a monitored search, `,_jsx(_components.code,{children:`status`}),` and `,_jsx(_components.code,{children:`stop_reason`}),` describe the most recent run, and `,_jsx(_components.code,{children:`progress`}),` and `,_jsx(_components.code,{children:`cost_usd`}),` are totals across all runs.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`frequency`,type:`string`,required:true,id:`param-frequency-1`,children:[_jsx(_components.p,{children:`How often the search runs again.`}),_jsxs(_components.p,{children:[`Options: `,_jsx(_components.code,{children:`daily`}),`, `,_jsx(_components.code,{children:`weekly`}),`.`]})]}),_jsx(ResponseField,{name:`status`,type:`string`,required:true,id:`param-status-1`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`active`}),` when runs are scheduled. `,_jsx(_components.code,{children:`paused`}),` when the schedule is kept but runs are skipped.`]})}),_jsx(ResponseField,{name:`runs_completed`,type:`integer`,required:true,id:`param-runs-completed`,children:_jsx(_components.p,{children:`How many runs have finished, including the first.`})}),_jsx(ResponseField,{name:`last_run_at`,type:`string | null`,required:true,id:`param-last-run-at`,children:_jsx(_components.p,{children:`When the most recent run finished.`})}),_jsx(ResponseField,{name:`next_run_at`,type:`string | null`,required:true,id:`param-next-run-at`,children:_jsxs(_components.p,{children:[`When the next run is due. `,_jsx(_components.code,{children:`null`}),` while paused.`]})})]})]}),`\n`,_jsx(ResponseField,{name:`created_at`,type:`string`,required:true,id:`param-created-at`,children:_jsx(_components.p,{children:`When the search was started.`})}),`\n`,_jsx(ResponseField,{name:`completed_at`,type:`string | null`,required:true,id:`param-completed-at`,children:_jsx(_components.p,{children:`When the search reached a terminal status.`})}),`\n`,_jsx(ResponseField,{name:`expires_at`,type:`string | null`,required:true,id:`param-expires-at`,children:_jsxs(_components.p,{children:[`When the search and its results stop being readable. `,_jsx(_components.code,{children:`null`}),` when no expiry is set.`]})}),`\n`,_jsx(ResponseField,{name:`status_url`,type:`string`,required:true,id:`param-status-url`,children:_jsx(_components.p,{children:`The URL of this search’s status.`})}),`\n`,_jsx(ResponseField,{name:`results_url`,type:`string`,required:true,id:`param-results-url`,children:_jsx(_components.p,{children:`The URL of this search’s results.`})}),`\n`,_jsx(Heading,{level:`3`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`When`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_request`})}),_jsxs(_components.td,{children:[`The request is invalid, for example a `,_jsx(_components.code,{children:`frequency`}),` other than `,_jsx(_components.code,{children:`daily`}),` or `,_jsx(_components.code,{children:`weekly`}),`, or a search that was cancelled.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_api_key`})}),_jsx(_components.td,{children:`The API key is missing, invalid or revoked.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`not_found`})}),_jsx(_components.td,{children:`No such object in this workspace.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`429`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`rate_limited`})}),_jsxs(_components.td,{children:[`Too many requests. Retry after `,_jsx(_components.code,{children:`Retry-After`}),` seconds.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`internal_error`})}),_jsxs(_components.td,{children:[`Something went wrong on our side. Retry with backoff, and with the same `,_jsx(_components.code,{children:`Idempotency-Key`}),` if you sent one.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Every error uses the same shape. See `,_jsx(_components.a,{href:`/api-reference/errors`,children:`Errors`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Monitor a company search","sidebarTitle":"Monitor a search","description":"Runs a company search again on a schedule, so it keeps finding new companies.","api":"PUT https://api.avina.io/v1/companies/search/{search_id}/monitor","href":"/api-reference/companies/monitor-search"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Expandable,Heading,ParamField,RequestExample,ResponseExample,ResponseField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Monitoring turns a one-time search into a scheduled one. At each run, the search looks for companies that match and are not already in its results, and adds up to `,_jsx(_components.code,{children:`limit`}),` new ones. Read them from the same `,_jsx(_components.a,{href:`/api-reference/companies/list-results`,children:`results endpoint`}),`, passing your last `,_jsx(_components.code,{children:`next_cursor`}),` as `,_jsx(_components.code,{children:`after`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Send this request for any search that has finished, or set `,_jsx(_components.code,{children:`monitor`}),` when you `,_jsx(_components.a,{href:`/api-reference/companies/search`,children:`start the search`}),`. Sending it again changes the frequency, or pauses and resumes the schedule.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Every run is charged like a search. The search’s `,_jsx(_components.code,{children:`max_cost_usd`}),` applies to each run. See `,_jsx(_components.a,{href:`/guides/scheduled-searches`,children:`Scheduled searches`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`example-bodies`,children:`Example bodies`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Run daily`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"frequency\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"daily\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Pause`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"frequency\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"daily\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"paused\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`3`,id:`path-parameters`,children:`Path parameters`}),`\n`,_jsx(ParamField,{path:`search_id`,type:`string`,required:true,id:`param-search-id`,children:_jsxs(_components.p,{children:[`The search’s `,_jsx(_components.code,{children:`id`}),`, returned when it was started.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`body`,children:`Body`}),`\n`,_jsx(ParamField,{body:`frequency`,type:`string`,required:true,id:`param-frequency`,children:_jsxs(_components.p,{children:[`How often the search runs again. `,_jsx(_components.code,{children:`daily`}),` runs every 24 hours and `,_jsx(_components.code,{children:`weekly`}),` every 7 days, counted from when monitoring was turned on.`]})}),`\n`,_jsx(ParamField,{body:`paused`,type:`boolean`,default:`false`,id:`param-paused`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`true`}),` keeps the schedule but skips runs until you set it back to `,_jsx(_components.code,{children:`false`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:_jsx(_components.code,{children:`200`})}),` The search, with its schedule in `,_jsx(_components.code,{children:`monitor`}),`.`]}),`\n`,_jsx(ResponseField,{name:`object`,type:`string`,required:true,id:`param-object`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`company_search`}),` or `,_jsx(_components.code,{children:`people_search`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`The search’s identifier. Use it to read status and results.`})}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,required:true,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`queued`}),` and `,_jsx(_components.code,{children:`running`}),` are in progress. `,_jsx(_components.code,{children:`completed`}),`, `,_jsx(_components.code,{children:`failed`}),` and `,_jsx(_components.code,{children:`cancelled`}),` are terminal. `,_jsx(_components.code,{children:`completed`}),` means this run finished, not that every matching record in the world was found. A monitored search goes back to `,_jsx(_components.code,{children:`running`}),` at its next scheduled run.`]})}),`\n`,_jsxs(ResponseField,{name:`stop_reason`,type:`string | null`,required:true,id:`param-stop-reason`,children:[_jsxs(_components.p,{children:[`Why a finished search stopped. `,_jsx(_components.code,{children:`null`}),` while it is in progress. Can also be `,_jsx(_components.code,{children:`null`}),` on a `,_jsx(_components.code,{children:`failed`}),` search; read `,_jsx(_components.code,{children:`error`}),`.`]}),_jsxs(_components.p,{children:[`Options: `,_jsx(_components.code,{children:`target_reached`}),`, `,_jsx(_components.code,{children:`sources_exhausted`}),`, `,_jsx(_components.code,{children:`usage_limit_reached`}),`, `,_jsx(_components.code,{children:`retrieval_limit_reached`}),`, `,_jsx(_components.code,{children:`query_needs_clarification`}),`, `,_jsx(_components.code,{children:`provider_failed`}),`, `,_jsx(_components.code,{children:`cancelled`}),`.`]})]}),`\n`,_jsx(ResponseField,{name:`error`,type:`string | null`,required:true,id:`param-error`,children:_jsxs(_components.p,{children:[`A message when `,_jsx(_components.code,{children:`status`}),` is `,_jsx(_components.code,{children:`failed`}),`. Results found before the failure stay readable.`]})}),`\n`,_jsx(ResponseField,{name:`query`,type:`string | null`,required:true,id:`param-query`,children:_jsxs(_components.p,{children:[`The natural-language request, when the search was started with `,_jsx(_components.code,{children:`query`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`limit`,type:`integer`,required:true,id:`param-limit`,children:_jsx(_components.p,{children:`The most results this search will return.`})}),`\n`,_jsxs(ResponseField,{name:`interpretation`,type:`object | null`,required:true,id:`param-interpretation`,children:[_jsxs(_components.p,{children:[`How a `,_jsx(_components.code,{children:`query`}),` was read. `,_jsx(_components.code,{children:`null`}),` until the query has been interpreted, and for searches started with `,_jsx(_components.code,{children:`filters`}),` or `,_jsx(_components.code,{children:`criteria`}),`.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`filters`,type:`object`,id:`param-filters`,children:[_jsxs(_components.p,{children:[`Structured conditions. A record must meet every condition in `,_jsx(_components.code,{children:`all`}),`. `,_jsx(_components.code,{children:`null`}),` is treated the same as leaving `,_jsx(_components.code,{children:`filters`}),` out. See the `,_jsx(_components.a,{href:`/guides/structured-filters`,children:`filter reference`}),` for every field and operator.`]}),_jsx(Expandable,{title:`properties`,children:_jsxs(ResponseField,{name:`all`,type:`object[]`,required:true,id:`param-all`,children:[_jsxs(_components.p,{children:[`The conditions. A record must meet every one. Each item is a field condition (`,_jsx(_components.code,{children:`field`}),`, `,_jsx(_components.code,{children:`operator`}),`, `,_jsx(_components.code,{children:`value`}),`) or a `,_jsx(_components.code,{children:`related`}),` condition.`]}),_jsxs(Expandable,{title:`item properties`,children:[_jsx(ResponseField,{name:`field`,type:`string`,id:`param-field`,children:_jsxs(_components.p,{children:[`The field to test, such as `,_jsx(_components.code,{children:`company.industry`}),` or `,_jsx(_components.code,{children:`person.title`}),`.`]})}),_jsxs(ResponseField,{name:`operator`,type:`string`,id:`param-operator`,children:[_jsx(_components.p,{children:`How to compare. Which operators a field accepts depends on its type.`}),_jsxs(_components.p,{children:[`Options: `,_jsx(_components.code,{children:`in`}),`, `,_jsx(_components.code,{children:`matches`}),`, `,_jsx(_components.code,{children:`eq`}),`, `,_jsx(_components.code,{children:`gt`}),`, `,_jsx(_components.code,{children:`gte`}),`, `,_jsx(_components.code,{children:`lt`}),`, `,_jsx(_components.code,{children:`lte`}),`, `,_jsx(_components.code,{children:`between`}),`, `,_jsx(_components.code,{children:`within_last_days`}),`.`]})]}),_jsx(ResponseField,{name:`value`,type:`any`,id:`param-value`,children:_jsxs(_components.p,{children:[`The value to compare against. A list for `,_jsx(_components.code,{children:`in`}),`, a two-item list for `,_jsx(_components.code,{children:`between`}),`, a `,_jsx(_components.code,{children:`{amount, currency}`}),` object for money fields, a number of days for `,_jsx(_components.code,{children:`within_last_days`}),`.`]})}),_jsxs(ResponseField,{name:`related`,type:`object`,id:`param-related`,children:[_jsxs(_components.p,{children:[`A condition on records related to the company. All conditions in `,_jsx(_components.code,{children:`where`}),` must be true of the same record, for example one job listing.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`relationship`,type:`string`,required:true,id:`param-relationship`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`open_jobs`}),`: the company has at least one open job that matches. `,_jsx(_components.code,{children:`new_hires`}),`: someone with a matching title joined the company within the window.`]})}),_jsxs(ResponseField,{name:`where`,type:`object`,required:true,id:`param-where`,children:[_jsx(_components.p,{children:`Conditions on the related record.`}),_jsx(Expandable,{title:`properties`,children:_jsxs(ResponseField,{name:`all`,type:`object[]`,required:true,id:`param-all-1`,children:[_jsxs(_components.p,{children:[`Conditions on `,_jsx(_components.code,{children:`title`}),` (`,_jsx(_components.code,{children:`in`}),`), `,_jsx(_components.code,{children:`posted_at`}),` (`,_jsx(_components.code,{children:`within_last_days`}),`, for `,_jsx(_components.code,{children:`open_jobs`}),`) or `,_jsx(_components.code,{children:`started_at`}),` (`,_jsx(_components.code,{children:`within_last_days`}),`, for `,_jsx(_components.code,{children:`new_hires`}),`).`]}),_jsxs(Expandable,{title:`item properties`,children:[_jsxs(ResponseField,{name:`field`,type:`string`,required:true,id:`param-field-1`,children:[_jsx(_components.p,{children:`The field on the related record.`}),_jsxs(_components.p,{children:[`Options: `,_jsx(_components.code,{children:`title`}),`, `,_jsx(_components.code,{children:`posted_at`}),`, `,_jsx(_components.code,{children:`started_at`}),`.`]})]}),_jsx(ResponseField,{name:`operator`,type:`string`,required:true,id:`param-operator-1`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`in`}),` for `,_jsx(_components.code,{children:`title`}),`; `,_jsx(_components.code,{children:`within_last_days`}),` for `,_jsx(_components.code,{children:`posted_at`}),` and `,_jsx(_components.code,{children:`started_at`}),`.`]})}),_jsx(ResponseField,{name:`value`,type:`any`,required:true,id:`param-value-1`,children:_jsxs(_components.p,{children:[`A list of titles for `,_jsx(_components.code,{children:`in`}),`, or a whole number of days from 1 to 36500 for `,_jsx(_components.code,{children:`within_last_days`}),`.`]})})]})]})})]})]})]})]})]})})]}),_jsxs(ResponseField,{name:`criteria`,type:`object[]`,id:`param-criteria`,children:[_jsx(_components.p,{children:`Free-text requirements read from the query.`}),_jsxs(Expandable,{title:`item properties`,children:[_jsx(ResponseField,{name:`text`,type:`string`,required:true,id:`param-text`,children:_jsx(_components.p,{children:`The requirement, written as a statement that is true of a match.`})}),_jsx(ResponseField,{name:`kind`,type:`string`,id:`param-kind`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`attribute`}),`: a lasting fact the company’s own description could state, such as “sells to hospitals”. `,_jsx(_components.code,{children:`event`}),`: something that happened, such as “opened a location in Texas this year”; checked by web research.`]})})]})]}),_jsx(ResponseField,{name:`unsupported_criteria`,type:`string[]`,id:`param-unsupported-criteria`,children:_jsx(_components.p,{children:`Requirements no public source can confirm, quoted from the query. A search cannot run while there are any.`})}),_jsxs(ResponseField,{name:`errors`,type:`object[]`,id:`param-errors`,children:[_jsx(_components.p,{children:`Problems validating the filters the query was read as. A search cannot run while there are any.`}),_jsxs(Expandable,{title:`item properties`,children:[_jsx(ResponseField,{name:`field`,type:`string`,id:`param-field-2`,children:_jsx(_components.p,{children:`The filter path with the problem.`})}),_jsx(ResponseField,{name:`message`,type:`string`,required:true,id:`param-message`,children:_jsx(_components.p,{children:`What is wrong.`})})]})]})]})]}),`\n`,_jsxs(ResponseField,{name:`assumptions`,type:`object[]`,required:true,id:`param-assumptions`,children:[_jsx(_components.p,{children:`Ambiguous wording in the query and how it was read.`}),_jsxs(Expandable,{title:`item properties`,children:[_jsx(ResponseField,{name:`text`,type:`string`,required:true,id:`param-text-1`,children:_jsx(_components.p,{children:`The exact phrase from the query.`})}),_jsx(ResponseField,{name:`assumed`,type:`string`,required:true,id:`param-assumed`,children:_jsx(_components.p,{children:`The reading that was used.`})}),_jsx(ResponseField,{name:`alternatives`,type:`string[]`,required:true,id:`param-alternatives`,children:_jsx(_components.p,{children:`Other readings. Reword the query if one of these is what you meant.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`progress`,type:`object`,required:true,id:`param-progress`,children:[_jsx(_components.p,{children:`Counts so far. They only increase.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`candidates`,type:`integer`,required:true,id:`param-candidates`,children:_jsx(_components.p,{children:`Candidates checked so far.`})}),_jsx(ResponseField,{name:`accepted`,type:`integer`,required:true,id:`param-accepted`,children:_jsx(_components.p,{children:`Candidates that matched every requirement and were added to the results.`})}),_jsx(ResponseField,{name:`rejected`,type:`integer`,required:true,id:`param-rejected`,children:_jsx(_components.p,{children:`Candidates that failed at least one requirement.`})}),_jsx(ResponseField,{name:`unknown`,type:`integer`,required:true,id:`param-unknown`,children:_jsx(_components.p,{children:`Candidates whose evidence could not confirm every requirement. They are not returned.`})}),_jsx(ResponseField,{name:`not_returned`,type:`integer`,required:true,id:`param-not-returned`,children:_jsxs(_components.p,{children:[`Candidates that matched every requirement but were not returned because `,_jsx(_components.code,{children:`limit`}),` or a spend limit had already been reached.`]})}),_jsx(ResponseField,{name:`contacts_found`,type:`integer`,required:true,id:`param-contacts-found`,children:_jsxs(_components.p,{children:[`Contacts found so far. For company searches with `,_jsx(_components.code,{children:`persona_ids`}),`, and people searches with enrichment.`]})})]})]}),`\n`,_jsx(ResponseField,{name:`cost_usd`,type:`number`,required:true,id:`param-cost-usd`,children:_jsx(_components.p,{children:`What this search has cost so far, in US dollars, including the 5% platform fee.`})}),`\n`,_jsx(ResponseField,{name:`cancel_requested`,type:`boolean`,required:true,id:`param-cancel-requested`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`true`}),` after a cancel request, until the search reaches `,_jsx(_components.code,{children:`cancelled`}),`.`]})}),`\n`,_jsxs(ResponseField,{name:`monitor`,type:`object | null`,required:true,id:`param-monitor`,children:[_jsxs(_components.p,{children:[`The schedule, when the search is monitored. `,_jsx(_components.code,{children:`null`}),` for a search that runs once. On a monitored search, `,_jsx(_components.code,{children:`status`}),` and `,_jsx(_components.code,{children:`stop_reason`}),` describe the most recent run, and `,_jsx(_components.code,{children:`progress`}),` and `,_jsx(_components.code,{children:`cost_usd`}),` are totals across all runs.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`frequency`,type:`string`,required:true,id:`param-frequency-1`,children:[_jsx(_components.p,{children:`How often the search runs again.`}),_jsxs(_components.p,{children:[`Options: `,_jsx(_components.code,{children:`daily`}),`, `,_jsx(_components.code,{children:`weekly`}),`.`]})]}),_jsx(ResponseField,{name:`status`,type:`string`,required:true,id:`param-status-1`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`active`}),` when runs are scheduled. `,_jsx(_components.code,{children:`paused`}),` when the schedule is kept but runs are skipped.`]})}),_jsx(ResponseField,{name:`runs_completed`,type:`integer`,required:true,id:`param-runs-completed`,children:_jsx(_components.p,{children:`How many runs have finished, including the first.`})}),_jsx(ResponseField,{name:`last_run_at`,type:`string | null`,required:true,id:`param-last-run-at`,children:_jsx(_components.p,{children:`When the most recent run finished.`})}),_jsx(ResponseField,{name:`next_run_at`,type:`string | null`,required:true,id:`param-next-run-at`,children:_jsxs(_components.p,{children:[`When the next run is due. `,_jsx(_components.code,{children:`null`}),` while paused.`]})})]})]}),`\n`,_jsx(ResponseField,{name:`created_at`,type:`string`,required:true,id:`param-created-at`,children:_jsx(_components.p,{children:`When the search was started.`})}),`\n`,_jsx(ResponseField,{name:`completed_at`,type:`string | null`,required:true,id:`param-completed-at`,children:_jsx(_components.p,{children:`When the search reached a terminal status.`})}),`\n`,_jsx(ResponseField,{name:`expires_at`,type:`string | null`,required:true,id:`param-expires-at`,children:_jsxs(_components.p,{children:[`When the search and its results stop being readable. `,_jsx(_components.code,{children:`null`}),` when no expiry is set.`]})}),`\n`,_jsx(ResponseField,{name:`status_url`,type:`string`,required:true,id:`param-status-url`,children:_jsx(_components.p,{children:`The URL of this search’s status.`})}),`\n`,_jsx(ResponseField,{name:`results_url`,type:`string`,required:true,id:`param-results-url`,children:_jsx(_components.p,{children:`The URL of this search’s results.`})}),`\n`,_jsx(Heading,{level:`3`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`When`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_request`})}),_jsxs(_components.td,{children:[`The request is invalid, for example a `,_jsx(_components.code,{children:`frequency`}),` other than `,_jsx(_components.code,{children:`daily`}),` or `,_jsx(_components.code,{children:`weekly`}),`, or a search that was cancelled.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_api_key`})}),_jsx(_components.td,{children:`The API key is missing, invalid or revoked.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`not_found`})}),_jsx(_components.td,{children:`No such object in this workspace.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`429`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`rate_limited`})}),_jsxs(_components.td,{children:[`Too many requests. Retry after `,_jsx(_components.code,{children:`Retry-After`}),` seconds.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`internal_error`})}),_jsxs(_components.td,{children:[`Something went wrong on our side. Retry with backoff, and with the same `,_jsx(_components.code,{children:`Idempotency-Key`}),` if you sent one.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Every error uses the same shape. See `,_jsx(_components.a,{href:`/api-reference/errors`,children:`Errors`}),`.`]}),`\n`,_jsxs(RequestExample,{children:[_jsx(CodeBlock,{filename:`JSON`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"frequency\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"daily\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`6`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`curl`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` -X`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` PUT`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` https://api.avina.io/v1/companies/search/`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`$SEARCH_ID`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`/monitor`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` -H`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`$AVINA_API_KEY`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` -H`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` -d`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` \"frequency\": \"daily\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` }'`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`12`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`12`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:`import`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` os`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:`import`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`response `}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:`=`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` requests.put(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:` f`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"https://api.avina.io/v1/companies/search/`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`{`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`search_id`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`}`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`/monitor\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#E36209`,\"--shiki-dark\":`#FFAB70`},children:` headers`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:`=`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`{`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"Authorization\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:`f`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"Bearer `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`{`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`os.environ[`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`'AVINA_API_KEY'`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`]`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`}`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#E36209`,\"--shiki-dark\":`#FFAB70`},children:` json`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:`=`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` \"frequency\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"daily\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`response.raise_for_status()`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`print`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`(response.json())`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`JavaScript`,numberOfLines:`12`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`12`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:`const`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` response`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:` =`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:` await`}),_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:` fetch`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`(`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:\"`https://api.avina.io/v1/companies/search/${\"}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`searchId`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:\"}/monitor`\"}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` method: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"PUT\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` headers: {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` Authorization: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:\"`Bearer ${\"}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`process`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`.`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`env`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`.`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`AVINA_API_KEY`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:\"}`\"}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` \"Content-Type\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"application/json\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` body: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`JSON`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`.`}),_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`stringify`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` \"frequency\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"daily\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` }),`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`});`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:`const`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` data`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:` =`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F97583`},children:` await`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` response.`}),_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`json`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`();`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`console.`}),_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`log`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`(data);`})]}),`\n`]})})})]}),`\n`,_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`200`,numberOfLines:`33`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`33`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"object\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"company_search\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"32ba40da-e558-442a-8945-e93fc771afc9\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"completed\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"stop_reason\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"target_reached\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`null`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"query\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"Series B fintech companies in New York that are hiring compliance engineers\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"limit\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`25`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"interpretation\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`null`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"assumptions\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: [],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"progress\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"candidates\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`96`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"accepted\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`25`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"rejected\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`64`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"unknown\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`7`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"not_returned\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`0`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"contacts_found\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`0`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"cost_usd\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`9.87`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"cancel_requested\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`false`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"monitor\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"frequency\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"daily\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"active\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"runs_completed\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`1`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"last_run_at\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"2026-11-12T17:09:54Z\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"next_run_at\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"2026-11-13T17:30:00Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"2026-11-12T17:02:11Z\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"completed_at\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"2026-11-12T17:09:54Z\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"expires_at\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`null`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"status_url\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"https://api.avina.io/v1/companies/search/32ba40da-e558-442a-8945-e93fc771afc9/status\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"results_url\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"https://api.avina.io/v1/companies/search/32ba40da-e558-442a-8945-e93fc771afc9/results\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`400`,numberOfLines:`10`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`10`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"invalid_request\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"frequency: must be daily or weekly\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"request_id\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"req_8f2a61c09d4e7b3a5f10c2d8\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \"details\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` { `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"frequency\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`, `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:`\"message\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"must be daily or weekly\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`}`})}),`\n`]})})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Monitor a company search","sidebarTitle":"Monitor a search","description":"Runs a company search again on a schedule, so it keeps finding new companies.","api":"PUT https://api.avina.io/v1/companies/search/{search_id}/monitor","href":"/api-reference/companies/monitor-search"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Example bodies","slug":"example-bodies","depth":3,"children":[]},{"title":"Path parameters","slug":"path-parameters","depth":3,"children":[]},{"title":"Body","slug":"body","depth":3,"children":[]},{"title":"Response","slug":"response","depth":3,"children":[]},{"title":"Errors","slug":"errors","depth":3,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"JSON","html":"\u003cpre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"frequency\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"daily\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"6\">\u003cspan class=\"line\">\u003cspan style=\"color:#6F42C1;--shiki-dark:#B392F0\">curl\u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> -X\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\"> PUT\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\"> https://api.avina.io/v1/companies/search/\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">$SEARCH_ID\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">/monitor\u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> -H\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\"> \"Authorization: Bearer \u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">$AVINA_API_KEY\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"\u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> -H\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\"> \"Content-Type: application/json\"\u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> -d\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\"> \"frequency\": \"daily\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\"> }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Python","html":"\u003cpre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8\" language=\"python\">\u003ccode language=\"python\" numberOfLines=\"12\">\u003cspan class=\"line\">\u003cspan style=\"color:#D73A49;--shiki-dark:#F97583\">import\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> os\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D73A49;--shiki-dark:#F97583\">import\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> requests\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">response \u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#F97583\">=\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> requests.put(\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D73A49;--shiki-dark:#F97583\"> f\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"https://api.avina.io/v1/companies/search/\u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">{\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">search_id\u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">}\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">/monitor\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#E36209;--shiki-dark:#FFAB70\"> headers\u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#F97583\">=\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">{\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"Authorization\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#F97583\">f\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"Bearer \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">{\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">os.environ[\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">'AVINA_API_KEY'\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">]\u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">}\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">},\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#E36209;--shiki-dark:#FFAB70\"> json\u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#F97583\">=\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\"> \"frequency\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"daily\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">response.raise_for_status()\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">print\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">(response.json())\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"JavaScript","html":"\u003cpre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8\" language=\"javascript\">\u003ccode language=\"javascript\" numberOfLines=\"12\">\u003cspan class=\"line\">\u003cspan style=\"color:#D73A49;--shiki-dark:#F97583\">const\u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> response\u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#F97583\"> =\u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#F97583\"> await\u003c/span>\u003cspan style=\"color:#6F42C1;--shiki-dark:#B392F0\"> fetch\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">(\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">`https://api.avina.io/v1/companies/search/${\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">searchId\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">}/monitor`\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">, {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> method: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"PUT\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> headers: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> Authorization: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">`Bearer ${\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">process\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">.\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">env\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">.\u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">AVINA_API_KEY\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">}`\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\"> \"Content-Type\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"application/json\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> body: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">JSON\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">.\u003c/span>\u003cspan style=\"color:#6F42C1;--shiki-dark:#B392F0\">stringify\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">({\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\"> \"frequency\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"daily\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> }),\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">});\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D73A49;--shiki-dark:#F97583\">const\u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> data\u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#F97583\"> =\u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#F97583\"> await\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> response.\u003c/span>\u003cspan style=\"color:#6F42C1;--shiki-dark:#B392F0\">json\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">();\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">console.\u003c/span>\u003cspan style=\"color:#6F42C1;--shiki-dark:#B392F0\">log\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">(data);\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"200","html":"\u003cpre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"33\">\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"object\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"company_search\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"id\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"32ba40da-e558-442a-8945-e93fc771afc9\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"status\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"completed\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"stop_reason\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"target_reached\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"error\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">null\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"query\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"Series B fintech companies in New York that are hiring compliance engineers\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"limit\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">25\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"interpretation\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">null\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"assumptions\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: [],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"progress\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"candidates\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">96\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"accepted\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">25\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"rejected\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">64\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"unknown\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">7\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"not_returned\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">0\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"contacts_found\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">0\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"cost_usd\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">9.87\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"cancel_requested\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">false\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"monitor\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"frequency\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"daily\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"status\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"active\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"runs_completed\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">1\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"last_run_at\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"2026-11-12T17:09:54Z\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"next_run_at\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"2026-11-13T17:30:00Z\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"created_at\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"2026-11-12T17:02:11Z\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"completed_at\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"2026-11-12T17:09:54Z\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"expires_at\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">null\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"status_url\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"https://api.avina.io/v1/companies/search/32ba40da-e558-442a-8945-e93fc771afc9/status\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"results_url\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"https://api.avina.io/v1/companies/search/32ba40da-e558-442a-8945-e93fc771afc9/results\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"400","html":"\u003cpre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"10\">\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"error\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"code\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"invalid_request\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"message\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"frequency: must be daily or weekly\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"request_id\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"req_8f2a61c09d4e7b3a5f10c2d8\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\"> \"details\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> { \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">\"field\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"frequency\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">, \u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#79B8FF\">\"message\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">: \u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#9ECBFF\">\"must be daily or weekly\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#E1E4E8\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Monitor a company search","path":"/v1/companies/search/{search_id}/monitor","servers":[{"url":"https://api.avina.io"}],"method":"put","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{"search_id":{"schema":[{"type":"string","description":"The search’s `id` , returned when it was started.","required":true}]}}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"frequency":[{"type":"string","description":"How often the search runs again. `daily` runs every 24 hours and `weekly` every 7 days, counted from when monitoring was turned on.","required":true}],"paused":[{"type":"boolean","description":"`true` keeps the schedule but skips runs until you set it back to `false` ."}]}}],"examples":{"example":{"value":{"frequency":"\u003cstring>","paused":true}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"object":[{"type":"string","description":"`company_search` or `people_search` .","required":true}],"id":[{"type":"string","description":"The search’s identifier. Use it to read status and results.","required":true}],"status":[{"type":"string","description":"`queued` and `running` are in progress. `completed` , `failed` and `cancelled` are terminal. `completed` means this run finished, not that every matching record in the world was found. A monitored search goes back to `running` at its next scheduled run.","required":true}],"stop_reason":[{"type":"object","properties":{},"description":"Why a finished search stopped. `null` while it is in progress. Can also be `null` on a `failed` search; read `error` . Options: `target_reached` , `sources_exhausted` , `usage_limit_reached` , `retrieval_limit_reached` , `query_needs_clarification` , `provider_failed` , `cancelled` .","required":true}],"error":[{"type":"object","properties":{},"description":"A message when `status` is `failed` . Results found before the failure stay readable.","required":true}],"query":[{"type":"object","properties":{},"description":"The natural-language request, when the search was started with `query` .","required":true}],"limit":[{"type":"integer","description":"The most results this search will return.","required":true}],"interpretation":[{"type":"object","properties":{"filters":[{"type":"object","properties":{"all":[{"type":"array","items":[{"type":"object","properties":{"field":[{"type":"string","description":"The field to test, such as `company.industry` or `person.title` ."}],"operator":[{"type":"string","description":"How to compare. Which operators a field accepts depends on its type. Options: `in` , `matches` , `eq` , `gt` , `gte` , `lt` , `lte` , `between` , `within_last_days` ."}],"value":[{"type":"any","description":"The value to compare against. A list for `in` , a two-item list for `between` , a `{amount, currency}` object for money fields, a number of days for `within_last_days` ."}],"related":[{"type":"object","properties":{"relationship":[{"type":"string","description":"`open_jobs` : the company has at least one open job that matches. `new_hires` : someone with a matching title joined the company within the window.","required":true}],"where":[{"type":"object","properties":{"all":[{"type":"array","items":[{"type":"object","properties":{"field":[{"type":"string","description":"The field on the related record. Options: `title` , `posted_at` , `started_at` .","required":true}],"operator":[{"type":"string","description":"`in` for `title` ; `within_last_days` for `posted_at` and `started_at` .","required":true}],"value":[{"type":"any","description":"A list of titles for `in` , or a whole number of days from 1 to 36500 for `within_last_days` .","required":true}]}}],"description":"Conditions on `title` ( `in` ), `posted_at` ( `within_last_days` , for `open_jobs` ) or `started_at` ( `within_last_days` , for `new_hires` ).","required":true}]},"description":"Conditions on the related record.","required":true}]},"description":"A condition on records related to the company. All conditions in `where` must be true of the same record, for example one job listing."}]}}],"description":"The conditions. A record must meet every one. Each item is a field condition ( `field` , `operator` , `value` ) or a `related` condition.","required":true}]},"description":"Structured conditions. A record must meet every condition in `all` . `null` is treated the same as leaving `filters` out. See the filter reference for every field and operator."}],"criteria":[{"type":"array","items":[{"type":"object","properties":{"text":[{"type":"string","description":"The requirement, written as a statement that is true of a match.","required":true}],"kind":[{"type":"string","description":"`attribute` : a lasting fact the company’s own description could state, such as “sells to hospitals”. `event` : something that happened, such as “opened a location in Texas this year”; checked by web research."}]}}],"description":"Free-text requirements read from the query."}],"unsupported_criteria":[{"type":"array","items":[{"type":"string"}],"description":"Requirements no public source can confirm, quoted from the query. A search cannot run while there are any."}],"errors":[{"type":"array","items":[{"type":"object","properties":{"field":[{"type":"string","description":"The filter path with the problem."}],"message":[{"type":"string","description":"What is wrong.","required":true}]}}],"description":"Problems validating the filters the query was read as. A search cannot run while there are any."}]},"description":"How a `query` was read. `null` until the query has been interpreted, and for searches started with `filters` or `criteria` .","required":true}],"assumptions":[{"type":"array","items":[{"type":"object","properties":{"text":[{"type":"string","description":"The exact phrase from the query.","required":true}],"assumed":[{"type":"string","description":"The reading that was used.","required":true}],"alternatives":[{"type":"array","items":[{"type":"string"}],"description":"Other readings. Reword the query if one of these is what you meant.","required":true}]}}],"description":"Ambiguous wording in the query and how it was read.","required":true}],"progress":[{"type":"object","properties":{"candidates":[{"type":"integer","description":"Candidates checked so far.","required":true}],"accepted":[{"type":"integer","description":"Candidates that matched every requirement and were added to the results.","required":true}],"rejected":[{"type":"integer","description":"Candidates that failed at least one requirement.","required":true}],"unknown":[{"type":"integer","description":"Candidates whose evidence could not confirm every requirement. They are not returned.","required":true}],"not_returned":[{"type":"integer","description":"Candidates that matched every requirement but were not returned because `limit` or a spend limit had already been reached.","required":true}],"contacts_found":[{"type":"integer","description":"Contacts found so far. For company searches with `persona_ids` , and people searches with enrichment.","required":true}]},"description":"Counts so far. They only increase.","required":true}],"cost_usd":[{"type":"number","description":"What this search has cost so far, in US dollars, including the 5% platform fee.","required":true}],"cancel_requested":[{"type":"boolean","description":"`true` after a cancel request, until the search reaches `cancelled` .","required":true}],"monitor":[{"type":"object","properties":{"frequency":[{"type":"string","description":"How often the search runs again. Options: `daily` , `weekly` .","required":true}],"status":[{"type":"string","description":"`active` when runs are scheduled. `paused` when the schedule is kept but runs are skipped.","required":true}],"runs_completed":[{"type":"integer","description":"How many runs have finished, including the first.","required":true}],"last_run_at":[{"type":"object","properties":{},"description":"When the most recent run finished.","required":true}],"next_run_at":[{"type":"object","properties":{},"description":"When the next run is due. `null` while paused.","required":true}]},"description":"The schedule, when the search is monitored. `null` for a search that runs once. On a monitored search, `status` and `stop_reason` describe the most recent run, and `progress` and `cost_usd` are totals across all runs.","required":true}],"created_at":[{"type":"string","description":"When the search was started.","required":true}],"completed_at":[{"type":"object","properties":{},"description":"When the search reached a terminal status.","required":true}],"expires_at":[{"type":"object","properties":{},"description":"When the search and its results stop being readable. `null` when no expiry is set.","required":true}],"status_url":[{"type":"string","description":"The URL of this search’s status.","required":true}],"results_url":[{"type":"string","description":"The URL of this search’s results.","required":true}]}}],"examples":{"example":{"value":{"object":"\u003cstring>","id":"\u003cstring>","status":"\u003cstring>","stop_reason":{},"error":{},"query":{},"limit":123,"interpretation":{"filters":{"all":[{"field":"\u003cstring>","operator":"\u003cstring>","value":"\u003cany>","related":{"relationship":"\u003cstring>","where":{"all":[{"field":"\u003cstring>","operator":"\u003cstring>","value":"\u003cany>"}]}}}]},"criteria":[{"text":"\u003cstring>","kind":"\u003cstring>"}],"unsupported_criteria":["\u003cstring>"],"errors":[{"field":"\u003cstring>","message":"\u003cstring>"}]},"assumptions":[{"text":"\u003cstring>","assumed":"\u003cstring>","alternatives":["\u003cstring>"]}],"progress":{"candidates":123,"accepted":123,"rejected":123,"unknown":123,"not_returned":123,"contacts_found":123},"cost_usd":123,"cancel_requested":true,"monitor":{"frequency":"\u003cstring>","status":"\u003cstring>","runs_completed":123,"last_run_at":{},"next_run_at":{}},"created_at":"\u003cstring>","completed_at":{},"expires_at":{},"status_url":"\u003cstring>","results_url":"\u003cstring>"}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"avina-api","siteName":"Avina Data API","title":"Monitor a company search - Avina Data API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T20:16:25.342Z","originalFileLocation":"api-reference/companies/monitor-search.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Runs a company search again on a schedule, so it keeps finding new companies.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Avina Data API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/avina-api/nqBDON8KBF3P_oY-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/avina-api/nqBDON8KBF3P_oY-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/avina-api/nqBDON8KBF3P_oY-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/avina-api/nqBDON8KBF3P_oY-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/avina-api/nqBDON8KBF3P_oY-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/avina-api/nqBDON8KBF3P_oY-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/avina-api/nqBDON8KBF3P_oY-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/avina-api/nqBDON8KBF3P_oY-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/avina-api/nqBDON8KBF3P_oY-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Monitor a company search - Avina Data API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Runs a company search again on a schedule, so it keeps finding new companies.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Avina Data API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.data.avina.io/api-reference/companies/monitor-search\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://avina-api.mintlify.site/_mintlify/api/og/v2?division=Companies\u0026amp;title=Monitor+a+company+search\u0026amp;description=Runs+a+company+search+again+on+a+schedule%2C+so+it+keeps+finding+new+companies.\u0026amp;theme=b716ebad59b9d1b2e2f9649e\u0026amp;signature=5b0d6f12aba49a9fbda7d197a908f0251eeb0677f865de9c7104f1397106bfe5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Monitor a company search - Avina Data API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Runs a company search again on a schedule, so it keeps finding new companies.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://avina-api.mintlify.site/_mintlify/api/og/v2?division=Companies\u0026amp;title=Monitor+a+company+search\u0026amp;description=Runs+a+company+search+again+on+a+schedule%2C+so+it+keeps+finding+new+companies.\u0026amp;theme=b716ebad59b9d1b2e2f9649e\u0026amp;signature=5b0d6f12aba49a9fbda7d197a908f0251eeb0677f865de9c7104f1397106bfe5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/avina-api/nqBDON8KBF3P_oY-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Avina Data API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7D4CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.data.avina.io/api-reference/companies/monitor-search\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/companies/monitor-search.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.data.avina.io/#organization\",\"name\":\"Avina Data API\",\"url\":\"https://docs.data.avina.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/avina-api/RKvQej-a7A7w7r8I/logo/avina-light.png?fit=max\u0026auto=format\u0026n=RKvQej-a7A7w7r8I\u0026q=85\u0026s=5f5ab43b1cc341eb8d68192209f27e96\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.data.avina.io#website\",\"name\":\"Avina Data API\",\"url\":\"https://docs.data.avina.io\",\"publisher\":{\"@id\":\"https://docs.data.avina.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.data.avina.io/api-reference/companies/monitor-search#webpage\",\"url\":\"https://docs.data.avina.io/api-reference/companies/monitor-search\",\"name\":\"Monitor a company search\",\"description\":\"Runs a company search again on a schedule, so it keeps finding new companies.\",\"dateModified\":\"2026-11-18T20:16:25.342Z\",\"isPartOf\":{\"@id\":\"https://docs.data.avina.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.data.avina.io/api-reference/companies/monitor-search#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.data.avina.io/api-reference/companies/monitor-search#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Companies\",\"item\":\"https://docs.data.avina.io/api-reference/companies/search\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Monitor a company search\",\"item\":\"https://docs.data.avina.io/api-reference/companies/monitor-search\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.data.avina.io/api-reference/companies/monitor-search#apireference\",\"headline\":\"Monitor a company search\",\"name\":\"Monitor a company search\",\"description\":\"Runs a company search again on a schedule, so it keeps finding new companies.\",\"url\":\"https://docs.data.avina.io/api-reference/companies/monitor-search\",\"mainEntityOfPage\":{\"@id\":\"https://docs.data.avina.io/api-reference/companies/monitor-search#webpage\"},\"dateModified\":\"2026-11-18T20:16:25.342Z\",\"publisher\":{\"@id\":\"https://docs.data.avina.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.data.avina.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Avina Data API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Avina Data API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/companies/monitor-search.md","siteName":"Avina Data API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/api-reference/introduction"},{"title":"Errors","href":"/api-reference/errors"},{"title":"OpenAPI specification","sidebarTitle":"OpenAPI spec","href":"/api-reference/openapi"}]},{"group":"Companies","pages":[{"title":"Start a company search","sidebarTitle":"Start a search","api":"POST https://api.avina.io/v1/companies/search","href":"/api-reference/companies/search"},{"title":"Get a company search","sidebarTitle":"Get search status","api":"GET https://api.avina.io/v1/companies/search/{search_id}/status","href":"/api-reference/companies/get-search"},{"title":"List company search results","sidebarTitle":"List results","api":"GET https://api.avina.io/v1/companies/search/{search_id}/results","href":"/api-reference/companies/list-results"},{"title":"Cancel a company search","sidebarTitle":"Cancel a search","description":"Stops a company search from starting new work.","api":"POST https://api.avina.io/v1/companies/search/{search_id}/cancel","href":"/api-reference/companies/cancel-search"},{"title":"Monitor a company search","sidebarTitle":"Monitor a search","api":"PUT https://api.avina.io/v1/companies/search/{search_id}/monitor","href":"/api-reference/companies/monitor-search"},{"title":"Stop monitoring a company search","sidebarTitle":"Stop monitoring","description":"Removes the schedule from a company search.","api":"DELETE https://api.avina.io/v1/companies/search/{search_id}/monitor","href":"/api-reference/companies/stop-monitoring"}]},{"group":"People","pages":[{"title":"Start a people search","sidebarTitle":"Start a search","api":"POST https://api.avina.io/v1/people/search","href":"/api-reference/people/search"},{"title":"Get a people search","sidebarTitle":"Get search status","api":"GET https://api.avina.io/v1/people/search/{search_id}/status","href":"/api-reference/people/get-search"},{"title":"List people search results","sidebarTitle":"List results","api":"GET https://api.avina.io/v1/people/search/{search_id}/results","href":"/api-reference/people/list-results"},{"title":"Cancel a people search","sidebarTitle":"Cancel a search","api":"POST https://api.avina.io/v1/people/search/{search_id}/cancel","href":"/api-reference/people/cancel-search"},{"title":"Monitor a people search","sidebarTitle":"Monitor a search","api":"PUT https://api.avina.io/v1/people/search/{search_id}/monitor","href":"/api-reference/people/monitor-search"},{"title":"Stop monitoring a people search","sidebarTitle":"Stop monitoring","api":"DELETE https://api.avina.io/v1/people/search/{search_id}/monitor","href":"/api-reference/people/stop-monitoring"}]},{"group":"Parse","pages":[{"title":"Parse a company query","sidebarTitle":"Parse a company query","api":"POST https://api.avina.io/v1/companies/search/parse","href":"/api-reference/parse/companies"},{"title":"Parse a people query","sidebarTitle":"Parse a people query","api":"POST https://api.avina.io/v1/people/search/parse","href":"/api-reference/parse/people"}]},{"group":"Personas","pages":[{"title":"List personas","sidebarTitle":"List personas","api":"GET https://api.avina.io/v1/personas","href":"/api-reference/personas/list"},{"title":"Create a persona","sidebarTitle":"Create a persona","api":"POST https://api.avina.io/v1/personas","href":"/api-reference/personas/create"},{"title":"Get a persona","sidebarTitle":"Get a persona","api":"GET https://api.avina.io/v1/personas/{persona_id}","href":"/api-reference/personas/get"},{"title":"Update a persona","sidebarTitle":"Update a persona","api":"PATCH https://api.avina.io/v1/personas/{persona_id}","href":"/api-reference/personas/update"},{"title":"Delete a persona","sidebarTitle":"Delete a persona","api":"DELETE https://api.avina.io/v1/personas/{persona_id}","href":"/api-reference/personas/delete"}]},{"group":"Account","pages":[{"title":"Get the current API key","sidebarTitle":"Get the current key","api":"GET https://api.avina.io/v1/me","href":"/api-reference/account/me"},{"title":"Get balance and usage","sidebarTitle":"Get balance and usage","api":"GET https://api.avina.io/v1/usage","href":"/api-reference/account/usage"}]},{"group":"Coming Soon","pages":[{"title":"Create a watch","sidebarTitle":"Watch","api":"POST https://api.avina.io/v1/companies/watches","playground":"none","tag":"Coming Soon","href":"/api-reference/watch"},{"title":"Enrich companies","sidebarTitle":"Enrich","api":"POST https://api.avina.io/v1/companies/enrich","playground":"none","tag":"Coming Soon","href":"/api-reference/enrich"},{"title":"Ask a question","sidebarTitle":"Ask","api":"POST https://api.avina.io/v1/ask","playground":"none","tag":"Coming Soon","href":"/api-reference/ask"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Monitor a company search - Avina Data API","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-BtG4DSkw.js","snippetPresets-C1k1xDhp.js","utils-PMJoEt4Y.js","style-to-object-BY3JEAdk.js","utils-DW3Pr7Jq.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DIISLO2w.js","conditional-requirements-CFM0id0Q.js","cloneDeep-BErNCZCm.js","_Uint8Array-f0PCu9f_.js","isObject-FP1Yky1u.js","ApiExamples-OjY-8mqu.js","usePlaygroundInputsStore-B2HS2hUb.js","shallow-DVFuuIDQ.js","isEqual-DG0UKiQC.js","CodeSnippets-Cy6FBgwN.js","CodeSnippet-D1PtG8ed.js","getApiPlaygroundDisplay-Dkx2eNtL.js","Page-C8Cg25if.js","DynamicMarkdown-BvJIe00T.js","SectionHeading-B0rKYV8d.js","icon-yclzBff4.js","MethodPill-DxA11cCF.js","getPastedJson-CpkIDpMk.js","DuplicateIcon-CFCQNJ-D.js","axios-CsQoIw0U.js"]}