Get summary metrics and details for an import session

GET

/api/volunteers/import/session/{id}/summary

const url = 'https://example.com/api/volunteers/import/session/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/summary';
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://example.com/api/volunteers/import/session/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/summary \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

Session summary retrieved successfully

application/json

object

required

string format: uuid

organization_id

required

string format: uuid

partner_id

required

string format: uuid

created_by

required

string format: uuid

reconcile_exceptions

boolean

status

required

string

stats

required

object

created_at

required

string format: date-time

expires_at

required

string format: date-time

warnings

Array<object>

object

string format: uuid

session_id

string format: uuid

file_type

required

string

row_number

required

integer

raw_data

object

warning_code

required

string

message

required

string

created_at

string format: date-time

Example

{
  "reconcile_exceptions": false,
  "status": "active",
  "warnings": [
    {
      "file_type": "roster",
      "row_number": 12,
      "warning_code": "INVALID_PHONE",
      "message": "Failed to normalize phone number"
    }
  ]
}

401

Authentication required or invalid credentials

application/problem+json

RFC 7807 Problem Details for HTTP APIs

object

type

required

string

title

required

string

status

required

Current status of the record or process.

integer

detail

required

string

instance

string

retry_after

integer

Example

{
  "status": "IN_PROGRESS",
  "retry_after": 60
}

403

Access denied / Insufficient role privileges

application/problem+json

RFC 7807 Problem Details for HTTP APIs

object

type

required

string

title

required

string

status

required

Current status of the record or process.

integer

detail

required

string

instance

string

retry_after

integer

Example

{
  "status": "IN_PROGRESS",
  "retry_after": 60
}

404

Resource not found

application/problem+json

RFC 7807 Problem Details for HTTP APIs

object

type

required

string

title

required

string

status

required

Current status of the record or process.

integer

detail

required

string

instance

string

retry_after

integer

Example

{
  "status": "IN_PROGRESS",
  "retry_after": 60
}