Get Batch Imported Events

Version: v2

Get the event details for successful events imported from a batch 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

include_schema boolean optional

Whether to include the schema in the response.

Responses

200

A successful response.

Schema

Example

Schema

results object[] optional

Page of events import responses for the batch import

Array [

user object optional

The user identifier

id string optional

uid string optional

session object optional

The session identifier. If the event is attached to a session.

id string optional

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

uid string optional

The application-specific ID you've given to the 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.

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.

]

total_records string optional

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": [
    {
      "user": {
        "id": "123456789",
        "uid": "xyz123"
      },
      "session": {
        "id": "123456789:1298251231",
        "uid": "xyz123"
      },
      "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": "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 Events​

Get Batch Imported Events