Emit event

Emit an Event

Emits a single event to the telemetry service. This method is used to emit events which are not part of a series. The event in question is enriched/decorated with additional context, and then acknowledged or rejected.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Specifies the collection to which this event belongs. Named event collections are used for certain types of events which are grouped together for reporting purposes.

boolean

Whether this event is a standalone event (true), or part of a series (false). Only applicable when sending streams of events.

uint32

Index of this event within the ordinal context of all events sent for a given event stream or session. Only applicable in circumstances where events have a natural order.

string

Scope or operational context ID for this event. This value may be mixed into the event's ID and other data. This value is optional. For example, it may be filled in with a build ID in CI systems.

string

Specifies a relevance scope for this event; this value is calculated by the system, and may be provided in some circumstances in order to group related events.

string

Specifies a semi-unique ID for this event, which is used by the telemetry system to de-duplicate events at the time of delivery to the API. If an event has been received before, it may be rejected, or omitted during processing.

string

Specifies the organization tenant which this event is associated with. This field is automatically added to the event based on the event source and API key, and is only present for organization-related events.

string

Specifies the user account which this event is associated with. This field is automatically added to the event based on the event source and API key, and is only present for events which relate to a user.

uint32

ID of the organization tenant.

string

Short name of the organization tenant.

string

ID of the user account which relates to this event.

string

Email address for the user account which relates to this event. Hashed with SHA-256.

string

Username for the user which relates to this event, as applicable. If this event is a tenant-bound event, this username will be the user's in-context tenant username, as applicable.

string
enum

Provider which hosts the repository that relates to this event.

Allowed:
string
string

Display name for the source repository.

string

Specifies a shortname for the operating system. For example, for macOS, this would be "macOS".

string
enum

Specifies the OS family that relates to the operating system info being expressed.

Allowed:
string
enum

Specifies the architecture which the source operating system is running, if known.

Allowed:
uint32

Major version number. In the example 1.2.3, this value would be 1.

uint32

Minor version number. In the example 1.2.3, this value would be 2.

uint32

Micro version number. In the example 1.2.3, this value would be 3.

string

If there is a build number or tag value, it should be supplied here.

string

If there is a release candidate number or string, it should be supplied here.

string

If there is a known commit to which a version relates, it should be supplied here.

string

If there is a known source control tag to which a version relates, it should be supplied here.

string

If there is a formatted representation of this version info, it should be expressed here.

string

If there is a release number associated with this version info, it should be expressed here. In some cases, the release number may be a timestamp.

string

Specifies the invoking API client name.

uint32

Major version number. In the example 1.2.3, this value would be 1.

uint32

Minor version number. In the example 1.2.3, this value would be 2.

uint32

Micro version number. In the example 1.2.3, this value would be 3.

string

If there is a build number or tag value, it should be supplied here.

string

If there is a release candidate number or string, it should be supplied here.

string

If there is a known commit to which a version relates, it should be supplied here.

string

If there is a known source control tag to which a version relates, it should be supplied here.

string

If there is a formatted representation of this version info, it should be expressed here.

string

If there is a release number associated with this version info, it should be expressed here. In some cases, the release number may be a timestamp.

string

Specifies a calculated time-hash value for this event. The time-hash is bound to the occurrence timestamp.

string

Specifies the time at which this event occurred. This timestamp is reported by the client when it forms the event, before transmission to the server.

string

Specifies the time at which the event was received by the server. This field can only be populated once the event has been processed by the Buildless service, so it is omitted on the client side.

string

Specifies the time at which the event was ingested by the pipeline. This field can only be populated once the event has been processed by the Buildless service, so it is omitted on the client side.

string

Specifies the salted and hashed bytes of the IP address which delivered this event. This value is guaranteed to be stable for a given input IP address within the scope of a Buildless tenant or user account.

string

Specifies the timezone code for the originating location of this event. This value is calculated by the telemetry system on a best-effort basis, or it can be declared and sent by the client.

double

Specifies the latitude value for this geo-point.

double

Specifies the longitude value for this geo-point.

string

Detected Nielsen metro (DMA) code for the provided location information on this event. This value is only available if the telemetry system is able to detect and resolve a Nielsen metro code for the provided location information.

string

Detected locality (city name) for this event. This value is a best-effort calculation, just like the nielsen code, unless location info is provided explicitly by the client.

string

Detected region (state or province) for this event. This value is a best-effort calculation, just like the other detected location values listed on this payload.

string

The only required value for an event locality payload. If not provided by the client, this value will be reliably detected (on a best-effort basis) and filled in on behalf of the client by the telemetry system.

string

Specifies the geo-hash tag value associated with this event location. This value is typically calculated by the service based on available geographic input material.

string

Detected edge region (state or province) for this event. This value is indicated by the edge CDN service, and specifies the edge region where traffic first entered the network.

string

Raw bytes of a timer ID which relates multiple events to each other. This value is expected and guaranteed to be unique within the scope of a given account and telemetry session.

uint32

Specifies the ordinal index of this event, within the set of events delivered for this timer or session. This acts as an ordering hint to the server, and is set by the client.

string

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: If no scheme is provided, https is assumed. An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

string

Must be a valid serialized protocol buffer of the above specified type.

Responses

401

Served when requisite credentials were missing from the request, or were expired.

403

Served when credentials are present but the user does not have permission.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json