Create Events Batch Import

Creates a batch events import job with the given list of event information.

This is the first step in an asynchronous workflow. This request can be made idempotent.

Payload Limits

The number of request objects that can be included in a single batch request is 50,000.

Header Parameters

Idempotency-Key string optional

Optional header for marking the request to be idempotent

Request Body required

The request payloads contains the list of events to be imported

requests object[] required
The list of event requests that should be imported
Array [
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

Responses

200

---

A successful response.

Schema

Example

---

Schema

job object required

Information about the job that was initiated to import the list of events submitted.

id string required

ID of the job.

status string required

Possible values: [PROCESSING, COMPLETED, FAILED]

Status of the job.

created date-time required

Time the job was accepted.

finished date-time optional

Time the job was finished, either successfully or unsuccessfully.

{
  "job": {
    "id": "abc123",
    "status": "PROCESSING",
    "created": "2017-01-15T01:30:15.01Z"
  }
}

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

Loading...