Skip to main content
GET
/
search
/
results
Async results
curl --request GET \
  --url https://api.agentfirst.dev/search/results \
  --header 'Authorization: Bearer <token>'
{
  "terms": "foo",
  "results": [
    {
      "type": "organic",
      "page": 1,
      "section": "main",
      "feature": 1,
      "position": 1,
      "url": "https://foofighters.com/",
      "title": "Foo Fighters",
      "site": "Foo Fighters",
      "visibleUrl": "https://foofighters.com",
      "date": null,
      "snippet": "Official website of Foo Fighters.",
      "rating": null,
      "votes": null,
      "sitelinks": [
        {
          "position": 1,
          "url": "https://foofighters.com/tour-dates/",
          "title": "Tour Dates"
        }
      ],
      "images": [
        {
          "position": 1,
          "source": "[Image data]",
          "altText": "foo from en.wikipedia.org"
        }
      ]
    }
  ],
  "resultsCount": 43,
  "pageCount": 1,
  "country": null,
  "subdivision": null,
  "city": null,
  "approxResultsCount": 255000000,
  "resultsOffset": null,
  "pageSize": null,
  "uule": null,
  "language": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string
required

The identifier returned by the search endpoint of the queued search to retrieve.

Response

The job results or status.

​
terms
string
required

The queried word or phrase.

Example:

"foo"

​
results
object[]
required
​
resultsCount
integer
required

The number of parsed results.

Required range: x >= 0
Example:

43

​
pageCount
integer
required

The number of retrieved results pages.

Required range: 1 <= x <= 10
Example:

1

​
country
string | null
required

The ISO code of the requested country.

Example:

null

​
subdivision
string | null
required

The partial ISO code of the requested subdivision.

Example:

null

​
city
string | null
required

The name of the requested city.

Example:

null

​
approxResultsCount
integer

The approximate number of indexed results.

Required range: x >= 0
Example:

255000000

​
resultsOffset
integer | null

The number of skipped initial results.

Required range: 0 <= x <= 100
Example:

null

​
pageSize
integer | null

The number of retrieved results per page.

Required range: 0 <= x <= 100
Example:

null

​
uule
string | null

The encoded string of the emulated location.

Example:

null

​
language
string | null

The name, ISO code, or Google code of the requested language.

Example:

null