JAjasper
GEO

Retrieve GEO run recommendations

Changed on

Findings for a run, filtered and paginated. Totals per severity and category cover every page.

get/v1/geo/analyses/{configId}/runs/{runId}/recommendations

Request

  • Base URL
    https://api.jasper.ai
  • URL
    https://api.jasper.ai/v1/geo/analyses/{configId}/runs/{runId}/recommendations
  • Auth
    • API key in header X-API-Key
    • or OAuth 2
      Authorization code: https://api.jasper.ai/oauth2/authorize
      Token URL: https://api.jasper.ai/oauth2/token scopes: user

Path parameters

configIdstring required
Example:agc_ABC123
runIdstring required
Example:aga_ABC123

Query parameters

severitystring
Example:critical,warning

Comma-separated severities.

categorystring[]

Comma-separated issue categories.

topicClusterIdstring

Restrict findings to one topic cluster.

topicClusterNamestring

Restrict findings to a name-only proposed topic cluster.

pagenumber
limitnumber

Response

requestIdstring required
resourcestring required

Example response

{
  "requestId": "8393f82b3f6a4f6e8a405777b9305254",
  "resource": "knowledge",
  "data": [
    {
      "location": {
        "title": "Pricing",
        "url": "https://www.jasper.ai/pricing"
      }
    }
  ],
  "pagination": {
    "totalRecords": 24,
    "page": 1,
    "pageSize": 20,
    "next": "https://api.jasper.ai/v1/geo/analyses/agc_ABC123/runs/aga_ABC123/recommendations?page=2&limit=20"
  }
}

Changes