Poll the status of an async analytics PDF export

Polls one asynchronous analytics PDF export.

GET/api/analytics/export/{jobId}/status

Polls one asynchronous analytics PDF export. A running export returns 202; a completed export returns the PDF attachment with 200; an unknown export returns 404; a failed export returns 500 with its customer-safe failure message. Running states are waiting, active, or delayed. Poll with backoff and stop after 200, 404, or 500. Job identifiers are opaque tokens and must not be parsed.

pages.docs.apiRequirements.title

pages.docs.apiRequirements.credentials: pages.docs.apiRequirements.credentialsIntro pages.docs.apiRequirements.bearerApiKey pages.docs.apiRequirements.or pages.docs.apiRequirements.apiKeyHeader.
pages.docs.apiRequirements.scope: analytics:read
pages.docs.apiRequirements.module: pages.docs.apiRequirements.automationApiModule (automation_api)
pages.docs.apiRequirements.tenantScope: All resources and identifiers are isolated to the authenticated organization. Identifiers owned by another organization or site are not disclosed.
pages.docs.apiRequirements.retryBehavior: pages.docs.apiRequirements.retryModes.safeRead: This read-only operation can be retried after transport failures without changing resource state.

Path Parameters

jobId*string

Unique identifier of the related job. Supplied in the path.

Response Body

`application/pdf`

`application/json`

"<binary PDF data>"

{
  "state": "active",
  "jobId": "12345"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "state": "failed",
  "error": "PDF renderer unavailable"
}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/analytics/export/exp_01J2B3C4D5E6F7G8H9J0K1M2N3/status' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/analytics/export/exp_01J2B3C4D5E6F7G8H9J0K1M2N3/status", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Poll the status of an async analytics PDF export

Polls one asynchronous analytics PDF export.

GET/api/analytics/export/{jobId}/status

pages.docs.apiRequirements.title

pages.docs.apiRequirements.credentials: pages.docs.apiRequirements.credentialsIntro pages.docs.apiRequirements.bearerApiKey pages.docs.apiRequirements.or pages.docs.apiRequirements.apiKeyHeader.
pages.docs.apiRequirements.scope: analytics:read
pages.docs.apiRequirements.module: pages.docs.apiRequirements.automationApiModule (automation_api)
pages.docs.apiRequirements.tenantScope: All resources and identifiers are isolated to the authenticated organization. Identifiers owned by another organization or site are not disclosed.
pages.docs.apiRequirements.retryBehavior: pages.docs.apiRequirements.retryModes.safeRead: This read-only operation can be retried after transport failures without changing resource state.

Path Parameters

jobId*string

Unique identifier of the related job. Supplied in the path.

Response Body

`application/pdf`

`application/json`

"<binary PDF data>"

{
  "state": "active",
  "jobId": "12345"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "state": "failed",
  "error": "PDF renderer unavailable"
}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/analytics/export/exp_01J2B3C4D5E6F7G8H9J0K1M2N3/status' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/analytics/export/exp_01J2B3C4D5E6F7G8H9J0K1M2N3/status", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Poll the status of an async analytics PDF export

pages.docs.apiRequirements.title

Path Parameters

Response Body

`application/pdf`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Poll the status of an async analytics PDF export

pages.docs.apiRequirements.title

Path Parameters

Response Body

`application/pdf`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Poll the status of an async analytics PDF export

pages.docs.apiRequirements.title

200application/pdf

202application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

Poll the status of an async analytics PDF export

pages.docs.apiRequirements.title

200application/pdf

202application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

`application/pdf`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/pdf`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`