GET /api/v1/site-searches

GET/api/v1/site-searches

Authorization

AuthorizationBearer token (Zawqi Agent Token) · headerrequired

Zawqi Agent Token. Send it as a Bearer token in the Authorization header.

Query parameters

qstringrequired

cursorstring | any

limitobject | any

Responses

200Success

itemsobject[]required

Show properties

Array of object

idstringrequired

slugstringrequired

urlstringrequired

siteNamestringrequired

publishedbooleanrequired

excerptstringrequired

sitePathstringrequired

nextCursorstring | anyrequired

Show properties

Any of:

string

string

any

any

accessobjectrequired

Show properties

Any of:

object

kindstringrequired

Allowed:free

catalogstringrequired

Allowed:curated_subset

searchesUsednumber | string | stringrequired

Show properties

Any of:

number | string

Any of:

number

number

string

string

string

string

string

string

string

string

searchesLimitnumber | string | stringrequired

Show properties

Any of:

number | string

Any of:

number

number

string

string

string

string

string

string

string

string

searchesRemainingnumber | string | stringrequired

Show properties

Any of:

number | string

Any of:

number

number

string

string

string

string

string

string

string

string

resetsAtstringrequired

messagestringrequired

object

kindstringrequired

Allowed:lifetime

catalogstringrequired

Allowed:complete

401Unauthorized

_tagstringrequired

Allowed:Unauthorized

422SearchQueryInvalid

_tagstringrequired

Allowed:SearchQueryInvalid

messagestringrequired

429FreeResearchWeeklyLimitReached

_tagstringrequired

Allowed:FreeResearchWeeklyLimitReached

messagestringrequired

searchesLimitnumber | string | stringrequired

Show properties

Any of:

number | string

Any of:

number

number

string

string

string

string

string

string

string

string

resetsAtstringrequired

Request

curl -X GET "https://pr-214.zawqi.app/api/v1/site-searches?q=string" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://pr-214.zawqi.app/api/v1/site-searches?q=string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Response

{
  "items": [
    {
      "id": "string",
      "slug": "string",
      "url": "string",
      "siteName": "string",
      "published": true,
      "excerpt": "string",
      "sitePath": "string"
    }
  ],
  "nextCursor": "string",
  "access": {
    "kind": "free",
    "catalog": "curated_subset",
    "searchesUsed": 0,
    "searchesLimit": 0,
    "searchesRemaining": 0,
    "resetsAt": "string",
    "message": "string"
  }
}