How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Unify Event Query Jobs API

Asynchronous Bulk API export of collected analytics events: create a query job, poll its status, page the results, or cancel it. 5 operation(s).

Unify Event Query Jobs API is one of 11 APIs that Unify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Event Query Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, rate-limit docs, and authentication docs.

This API exposes 5 operations across 4 paths, and defines 45 schemas. It is described by OpenAPI 3.0.0, at version 1.

Requests are made against a single base URL, https://api.unifygtm.com.

5 operations 4 paths 45 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1
Base URL
https://api.unifygtm.com/data/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Unify Event Query Jobs API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Event Query Jobs 5
POST
/data/v1/events/query-jobs
Start an asynchronous query job that exports analytics events — website and product activity (page, track, identify) with any revealed company and person embedded in each row. Events are immutable, s…
create_event_query_job body → 201400401429500
GET
/data/v1/events/query-jobs
List event query jobs, optionally filtered by status.
list_event_query_jobs 3 params → 200400401429500
GET
/data/v1/events/query-jobs/{job_id}
Get a query job's status. Poll until the status is terminal; results are available once the job is FINISHED. Jobs expire 24 hours after creation.
get_event_query_job 1 param → 200400401404429500
POST
/data/v1/events/query-jobs/{job_id}/cancel
Cancel a query job. Only INPROGRESS jobs can be canceled.
cancel_event_query_job 1 param → 200400401404409429500
GET
/data/v1/events/query-jobs/{job_id}/results
Get Bulk API job results. By default this returns JSON. Send Accept: application/x-ndjson to stream newline-delimited JSON.
get_event_query_job_results 3 params → 200400401404409410413429

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are UObjects.UPersonAttributes (18 properties), UObjects.UCompanyAttributes (16 properties), UEvent (10 properties), UValues.UAddress (9 properties). Each schema is shown below with its type and property counts.

BulkApiDatetimeRangeFilter
object
Datetime range filter. At least one bound must be provided. gt is mutually exclusive with gte, and lt is mutually exclusive with lte.
4 properties
BulkApiEventsQueryFilter
object
Filters accepted when querying events. Events are immutable, so the natural cursor is timestamp, which is also the only datetime field filterable here.
7 properties
BulkApiJob
object
Bulk API job representation.
7 properties 7 required
BulkApiJobStatus
string
Status of an asynchronous Bulk API job.
BulkApiUuidFilter
object
Filter matching a resource by ID.
1 property 1 required
CancelBulkApiJobNotCancelableResponse
object
Response returned when a Bulk API job is not cancelable.
CancelBulkApiJobSuccessResponse
object
Response returned when canceling a Bulk API job.
2 properties 2 required
CreateBulkApiEventsJobRequest
object
Request body for creating an events Bulk API query job.
1 property
CreateBulkApiJobSuccessResponse
object
Response returned when creating a Bulk API query job.
3 properties 3 required
EventType
string
Canonical, source-agnostic event type.
GetBulkApiJobNotFoundResponse
object
Response returned when a Bulk API job cannot be found.
GetBulkApiJobResultsCanceledResponse
object
Response returned when a Bulk API job was canceled and has no results.
GetBulkApiJobResultsExpiredResponse
object
Response returned when Bulk API job results have expired.
2 properties 2 required
GetBulkApiJobResultsFailedResponse
object
Response returned when a Bulk API job failed and has no results.
GetBulkApiJobResultsNotReadyResponse
object
Response returned when Bulk API job results are not ready yet.
GetBulkApiJobResultsPayloadTooLargeResponse
object
Response returned when a requested Bulk API results page is too large.
2 properties 2 required
GetBulkApiJobSuccessResponse
object
Response returned when fetching a Bulk API job.
ListBulkApiJobsSuccessResponse
object
Response returned when listing Bulk API jobs.
2 properties 2 required
UEvent
object
A flat, denormalized event row returned by an event Bulk API query job. Unlike object records, events are not wrapped in the object / attributes envelope. Page…
10 properties 10 required
UObjects.UCompany
object
5 properties 5 required
UObjects.UCompanyAttributes
object
16 properties 1 required
UObjects.UPerson
object
5 properties 5 required
UObjects.UPersonAttributes
object
18 properties 1 required
UResponses.BadRequestError
object
Validation error detail returned for bad request responses.
4 properties 1 required
UValues.UAddress
object
Composite object representing a physical address.
9 properties
UValues.UBoolean
boolean
Boolean value.
UValues.UCountry
object
Composite object representing a country.
2 properties 2 required
UValues.UCountryCode
string
ISO 3166-1 alpha-2 country code.
UValues.UCurrency
object
Composite object representing a currency value.
2 properties 2 required
UValues.UCurrencyCode
string
ISO 4217 currency code.
UValues.UDate
string
String value representing a date.
UValues.UDatetime
string
String value representing a datetime.
UValues.UDecimal
number
Decimal value.
UValues.UEmail
string
String value representing an email address.
UValues.UInteger
integer
Integer value.
UValues.UMultiSelect
array
String array that contains strings from a specific set of allowed values.
UValues.UPhoneNumber
string
String value representing a phone number.
UValues.UReferenceById
object
Reference to another object record by ID. This will find an existing record by its ID, and an error will be returned if the record does not exist.
1 property 1 required
UValues.UReferenceByMatch
object
Reference to another object record by match criteria. This will find an existing record using the provided match criteria, and null will be returned if no matc…
1 property 1 required
UValues.UReferenceByUpsert
object
Reference to another object record by performing a nested upsert. At least one of create, createorupdate or createorupdateifempty must be provided, and all req…
6 properties 1 required
UValues.USelect
string
String value that matches one of a specific set of allowed values.
UValues.UText
string
String value.
UValues.UUrl
string
String value representing a web URL or internet domain.
UValues.UUuid
string
String UUIDv4 value.
UValues.UValue

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unify-event-query-jobs-api-openapi.yml Raw ↑

Other APIs Unify publishes across the network.

Unify Analytics Events API
Unify Objects API
Unify Object Attributes API
Unify Object Attribute Options API
Unify Object Records API
Unify Object Record Query Jobs API
Unify Sequences API
Unify Sequence Enrollments API
Unify Sequence Enrollment Steps API
Unify Tasks API
Where this information came from

This is an independent, third-party profile of Unify Event Query Jobs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.