Get Batch Import Errors

Version: v2

Get the error message and code for any events that failed from an events 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 events import failures for the batch import

Array [

message string optional

A description of the failure encountered while importing the events.

code string optional

The error code.

event object optional

The corresponding events import request that resulted in the failure.

user object optional

The user identifier.

If session.id is provided, the session.id is enough to identify a session for which to create the event, and user will not be accepted.

If session.use_most_recent is set to true, one and only oneuser field is required.

uid string optional

Possible values: <= 256 characters

The application-specific ID you've given to the user.

id string optional

The Fullstory-assigned user ID. This value is returned in a POST /v2/users (create user) response.

session object optional

The session identifier.

id string optional

The Fullstory generated identifier for the session to associate the event with.

use_most_recent boolean optional

Associate events with the most recent session captured from the user.

If set to true, a user is required. The user must have a session within the past 30 minutes, otherwise the events will be created for the user without a session.

It is recommended to use session.id instead, when creating events for a specific session.

context object optional

The context in which the events are attached to.

browser object optional

The browser context in which the events are attached to.

url string optional

user_agent string optional

initial_referrer string optional

mobile object optional

The mobile context in which the events are attached to.

app_id string optional

app_version string optional

app_name string optional

build_variant string optional

device object optional

The device context in which the events are attached to.

manufacturer string optional

model string optional

screen_width int32 optional

screen_height int32 optional

viewport_width int32 optional

viewport_height int32 optional

location object optional

The location context in which the events are attached to.

country string optional

ISO 3166-1 alpha-2 standard country code.

region string optional

ISO-3166-2 standard region code.

city string optional

Name of the city.

latitude double optional

longitude double optional

ip_address string optional

name string required

The event's name.

timestamp ISO 8601 string optional

Optional. The event's timestamp represented in ISO 8601 format. If not provided, the current Fullstory server time will be used. It is recommended to always set the timestamp.

properties object optional

Optional. The custom event's payload.

schema object optional

Optional. Schema declaration, to define the structure of the data, the schema will override Fullstory's default type inference.

properties object optional

A mapping of field names to their corresponding types.

shared object optional

If there is any shared data from the original import request that may have caused conflict with data from within this event.

context object optional

The context in which the events are attached to.

browser object optional

The browser context in which the events are attached to.

url string optional

user_agent string optional

initial_referrer string optional

mobile object optional

The mobile context in which the events are attached to.

app_id string optional

app_version string optional

app_name string optional

build_variant string optional

device object optional

The device context in which the events are attached to.

manufacturer string optional

model string optional

screen_width int32 optional

screen_height int32 optional

viewport_width int32 optional

viewport_height int32 optional

location object optional

The location context in which the events are attached to.

country string optional

ISO 3166-1 alpha-2 standard country code.

region string optional

ISO-3166-2 standard region code.

city string optional

Name of the city.

latitude double optional

longitude double optional

ip_address string optional

]

total_records string optional

The total number of failures for the specified events 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": [
    {
      "event": {
        "session": {
          "id": "123456789:123456789"
        },
        "context": {
          "browser": {
            "url": "https://app.example.com",
            "user_agent": "Example_User_Agent",
            "initial_referrer": "https://referrer.example.com"
          }
        },
        "name": "Support Ticket",
        "timestamp": "2022-03-15T14:23:23Z",
        "properties": {
          "id": 424242,
          "priority": "Normal",
          "source": "Email",
          "title": "Account locked out"
        }
      }
    }
  ],
  "total_records": "98",
  "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 Import Errors​

Get Batch Import Errors