Get Batch Import Errors

Get the error message and code for any users that failed from a user import job.

This call is a step in an asynchronous workflow.

Path Parameters

job_id string required

ID that can be used to check the status and retrieve results for the batch import

Query Parameters

page_token string optional

The token that can be used in a request to fetch the next page of results

Responses

200

---

A successful response.

Schema

Example

---

Schema

results object[] optional
Page of user import failures for the batch import
Array [
message string required
Description of the failure encountered while importing the user
code string required
Error code
user object required
The request payloads contains the user data to be imported
id string optional
The Fullstory assigned user ID
uid string optional
Possible values: <= 256 characters
The application-specific ID you've given to the user
display_name string optional
Possible values: <= 256 characters
The nice-looking name for this user
email string optional
Possible values: <= 128 characters
The email address associated with this user
properties object optional
Properties that provide additional information about your user.
• Up to 500 unique properties are allowed.
• Property names must be a sequence of alphanumeric characters A-Z, a-z, or 0-9 and underscores ("_").
• Property names must start with an alphabetic character (A-Z or a-z).
• The maximum property name length is 512 characters.
• Property values may also contain nested objects. Properties within nested objects must still conform to the naming requirements. For nested objects, the property name including the dotted concatenation of all its parent properties must still be under the length limit of 512 characters.
• Property values have a maximum size of 8192 bytes. If the value for the property is larger than this limit, the property will be rejected.
schema object optional
Optional schema declaration, to define the structure of the data and override Fullstory's default type inference.
properties object optional
A mapping of field names to their corresponding types.
]
total_records string required

The total number of failures for the specified user import

next_page_token string optional

The token that can be used in a subsequent request to fetch the next page of import failures

{
  "results": [
    {
      "message": "The error message",
      "code": "error_code",
      "user": {
        "uid": "xyz123",
        "properties": {
          "rewards_status": "platinum"
        }
      }
    }
  ],
  "total_records": "1200",
  "next_page_token": "asd543="
}

Returned when this API is called while the job that is still processing.

Schema

---

Schema

any

Returned when invalid input has been provided. Fix the issue and retry.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "uid is required",
  "code": "required_field"
}

Returned when access to the resource is unauthorized.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "access is unauthorized",
  "code": "unauthorized"
}

Returned when access is not allowed due to insufficient permissions.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "insufficient permissions",
  "code": "forbidden"
}

Returned when the resource does not exist.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Requested resource does not exist",
  "code": "resource_not_found"
}

Returned when the client has exceeded the rate limit for this endpoint. A Retry-After header will be included with the response. This header will contain the number of seconds that you should wait before attempting to send another request.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Too many requests. Client has exceeded the rate limit for this endpoint.",
  "code": "too_many_requests"
}

Returned when a server error is encountered

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Server error was encountered",
  "code": "server_error"
}

GET /v2/users/batch/{job_id}/errors

Authorization: ApiKeyAuth

name: Authorizationin: headertype: apiKey

https://api.fullstory.com/v2/users/batch/{job_id}/errors

cURL

curl -L -X GET 'https://api.fullstory.com/v2/users/batch/:job_id/errors' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>'

Python

curl -L -X GET 'https://api.fullstory.com/v2/users/batch/:job_id/errors' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>'

Go

curl -L -X GET 'https://api.fullstory.com/v2/users/batch/:job_id/errors' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>'

Javascript

curl -L -X GET 'https://api.fullstory.com/v2/users/batch/:job_id/errors' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>'