Get export job status

GET

/exports/{exportId}

const url = 'https://app.surveyrock.com/api/v1/exports/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.surveyrock.com/api/v1/exports/example \
  --header 'Authorization: Bearer <token>'

Returns the current status of an export job. When status is ‘ready’, includes row_count. When expired (>7 days), returns status ‘expired’.

Authorizations

bearerAuth
reports:export

Parameters

Path Parameters

exportId

required

string

Export job ID

Responses

200

Export status

application/json

object

success

boolean

data

object

export_id

string

status

string

Allowed values: queued processing ready failed expired

row_count

Only present when status is ‘ready’

integer

nullable

meta

Standard response metadata

object

timestamp

Response timestamp in ISO 8601 format

string format: date-time

version

API version

string

requestId

Unique request identifier

string

Example

{
  "success": true,
  "data": {
    "status": "queued"
  },
  "meta": {
    "version": "3.0"
  }
}

404

Export not found

application/json

Standard error response format

object

success

boolean

error

object

code

Stable, snake_case domain code – see ApiErrorHandler::EXCEPTION_MAP and DomainException

string

message

Human-readable error message

string

suggestion

Imperative recovery hint for this domain code – see ApiErrorHandler::DOMAIN_CODE_SUGGESTIONS

string

retryable

Whether retrying the identical request might succeed without any change on the caller’s end

boolean

details

Additional, code-specific error details

object

meta

Standard response metadata

object

timestamp

Response timestamp in ISO 8601 format

string format: date-time

version

API version

string

requestId

Unique request identifier

string

Example

{
  "success": false,
  "error": {
    "code": "survey_not_found"
  },
  "meta": {
    "version": "3.0"
  }
}