JAjasper
GEO

Retrieve GEO run by ID

Changed on

Returns the whole run, or only the sections named in sections.

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

Request

  • Base URL
    https://api.jasper.ai
  • URL
    https://api.jasper.ai/v1/geo/analyses/{configId}/runs/{runId}
  • 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

sectionsstring
Example:overview,metrics,recommendations

Comma-separated run sections. Omit to return the whole run.

pagenumber

Page of the requested paginated section. Valid only when the request resolves to exactly one paginated section.

limitnumber

Page size for the paginated section.

Response

requestIdstring required
resourcestring required

Example response

{
  "requestId": "8393f82b3f6a4f6e8a405777b9305254",
  "resource": "knowledge",
  "data": {
    "providerCoverage": [
      {
        "coverageRate": 0.95
      }
    ],
    "recommendations": {
      "items": [
        {
          "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"
      },
      "byCategory": {
        "missing-faq": 4,
        "stale-content": 2
      }
    },
    "citations": [
      {
        "hostname": "www.jasper.ai",
        "occurrences": {
          "chatgpt": 3,
          "perplexity": 5
        },
        "urls": [
          {
            "url": "https://www.jasper.ai/pricing",
            "occurrences": {
              "chatgpt": 3,
              "perplexity": 5
            }
          }
        ]
      }
    ],
    "topicClusters": [
      {
        "brandMentions": [
          {
            "domain": "jasper.ai"
          }
        ]
      }
    ]
  }
}

Changes