POST
https://api.milda.ai/v1/companies/text-search/insightsText Search Insights
application/json01
Description
Explains why a company appeared in your Text Search results: the passage that ties it to your query, and the market segments it was found under.
How to Use
- Run Text Search and keep the
search_idfrom its response. - For any company in those results, send the
search_idand the company'scompany_id.
One company per request. A search_id can be used for 24 hours, only with the token that ran the search.
Response
insights– the passage from the company's website or other sources that matches your query, as plain text.nullwhen no passage could be extracted.source_urls– the pages the passage comes from, in the order its paragraphs appear.market_segments– the market segments the company was found under in that search.
Errors
404– thesearch_idis unknown, older than 24 hours or from another token, or the company is not in that search's results.
Credit Usage
- Free – the search itself is already paid for.
Rate Limit
10 requests per second
02
Headers
nameinreqdescription
tokenheaderone ofYour API token, sent as "token: YOUR_API_TOKEN". Send this or Authorization.
Authorizationheaderone ofThe same token in the standard form, sent as "Authorization: Bearer YOUR_API_TOKEN" (the word Bearer, a space, then your token). Send this or token.
03
Request body
TextSearchInsightsRequestTextSearchInsightsRequesttypereq2 fields
search_idstringyessearch_id returned by Text Search.
company_idstringyesID of a company in that search's results.
04
Responses
200 Successful Response422 Validation Error
TextSearchInsightstype5 fields
search_idstringThe search the insights are for.
company_idstringThe company the insights are for.
market_segmentsstring[]Market segments the company was found under in this search.
insightsstring | nullWhy the company matched: the passage from its website or other sources that ties it to the query, as plain text with paragraphs separated by blank lines. Null when none could be extracted.
source_urlsstring[]Pages the passage comes from, in the order its paragraphs appear.