Check whether the snippet has sent its first visit

POSTRequest

curl -X POST "https://prestigious-goldfish-661.convex.site/v1/autopilot/sources/site/check" \
    -H "Authorization: Bearer $REACHIZ_API_KEY"

Responses

200401403409429503

Response 200

Success

application/json

Example responseGenerated from schema

{
  "site": {
    "domain": "domain",
    "key": "key",
    "snippet": "snippet",
    "verifiedAt": "verifiedAt"
  },
  "posthog": {
    "region": "us",
    "projectId": "projectId"
  },
  "stripe": {
    "formerCustomers": -9007199254740991
  }
}

Response 401

The API key is missing or not valid.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 403

The key lacks the scope this route needs.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 409

The Idempotency-Key belongs to a different request, or the state does not allow this action.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 429

Too many requests.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 503

The service is busy. Retry with backoff.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Returns

Schema shown for 200 · application/json

• siteone of 2 variants
  Show 2 variants

  • object
    Show 4 properties

    • domainstring
    • keystring
    • snippetstring
    • verifiedAtone of 2 variants
      Show 2 variants

      • string
• posthogone of 2 variants
  Show 2 variants

  • object
    Show 2 properties

    • regionstring
      Allowed values: us, eu
    • projectIdstring
• stripeone of 2 variants
  Show 2 variants

  • object
    Show 1 property

    • formerCustomersone of 2 variants
      Show 2 variants

      • number