Skip to main content
POST
/
v1
/
geo
/
snapshots
cURL
curl --request POST \
  --url https://api.surnex.io/v1/geo/snapshots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "platform": "google",
  "location_code": 123,
  "language_code": "<string>",
  "targets": [
    {
      "type": "domain",
      "value": "<string>"
    }
  ],
  "options": {
    "include_top_domains": false,
    "include_top_pages": false,
    "include_evidence_rows": false
  }
}
'
{
  "snapshot_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "queued"
}

Authorizations

Authorization
string
header
required

Authorization: Bearer sk_...

Body

application/json

CreateGeoSnapshotRequest

platform
enum<string>
required
Available options:
google,
chat_gpt
location_code
integer
required
language_code
string
required
Minimum string length: 2
targets
object[]
required
Required array length: 1 - 10 elements
options
object

Response

Snapshot creation accepted

CreateGeoSnapshotResponse

snapshot_id
string<uuid>
required
status
enum<string>
required
Available options:
queued,
running,
complete,
partial,
failed