Get Batch Imported Users

Version: v2

Get the Fullstory id and user details for successful users imported from a batch 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

include_schema boolean optional

Whether to include schemas in the response.

Responses

200

A successful response.

Schema

Example

Schema

results object[] required

Page of user import responses for the batch import

Array [

id string required

Possible values: <= 256 characters

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

A mapping from fields to their types, whether inferred automatically or declared in the request.

properties object optional

A mapping of field names to their corresponding types.

type_conflicts object optional

Any fields that are associated with multiple types.

properties object optional

Any fields that are associated with multiple types.

]

total_records string required

Total number of records in this batch import

next_page_token string optional

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

{
  "results": [
    {
      "id": "123456789",
      "uid": "xyz123",
      "display_name": "Daniel Falko",
      "email": "daniel.falko@example.com",
      "properties": {
        "pricing_plan": "paid",
        "popup_help": true,
        "total_spent": 14.55
      },
      "schema": null,
      "type_conflicts": null
    }
  ],
  "total_records": "1200",
  "next_page_token": "asd543="
}

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

Schema

Example

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

Returned when access to the resource is unauthorized.

Schema

Example

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

Returned when access is not allowed due to insufficient permissions.

Schema

Example

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

Returned when the resource does not exist.

Schema

Example

{
  "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

{
  "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

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

Get Batch Imported Users​

Get Batch Imported Users