Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zaius RealtimeSegments API

The RealtimeSegments API from Zaius — 3 operation(s) for realtimesegments.

Zaius RealtimeSegments API is one of 17 APIs that Zaius publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include RealtimeSegments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 40 schemas. It is described by OpenAPI 3.0.1, at version v3.

Requests are made against 3 base URLs: https://api.us1.odp.optimizely.com/v3, https://api.eu1.odp.optimizely.com/v3, https://api.au1.odp.optimizely.com/v3.

6 operations 3 paths 40 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v3
Base URL
https://api.us1.odp.optimizely.com/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 6

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

RealtimeSegments 6
GET
/segments
List segments
RealtimeSegments_ListSegments → 200
GET
/segments/{segment_id}
Get segment
RealtimeSegments_GetSegment 1 param → 200
DELETE
/segments/{segment_id}
Delete segment
RealtimeSegments_UninstallSegment 1 param → 200404
POST
/segments/{segment_id}
Create segment
RealtimeSegments_CreateSegment 1 param body → 200201400
PUT
/segments/{segment_id}
Update segment
RealtimeSegments_InstallSegment 1 param body → 200201400
POST
/segments/{segment_id}:validate
Validate segment
RealtimeSegments_ValidateSegment 1 param body → 200400

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are Expression (21 properties), Sequence (6 properties), Collection (4 properties), ShiftTime (4 properties). Each schema is shown below with its type and property counts.

Continuation
object
4 properties
NoneOfString
object
Evaluates to boolean.
2 properties
InstallSegmentResponse
object
1 property
Collection
object
4 properties
BooleanLiteral
object
Evaluates to boolean.
1 property
Sequence
object
6 properties
LikeAnyOfString
object
Evaluates to boolean.
2 properties
SequenceCondition
object
3 properties
ShiftTime
object
Evaluates to number (epoch seconds).
4 properties
GetSegmentResponse
object
4 properties
TrueOrMissing
object
Evaluates to boolean.
1 property
ListSegmentsResponse
object
1 property
Expression
object
21 properties
Coalesce
object
Evaluates to type of source.
1 property
Comparison
object
Evaluates to boolean.
3 properties
TimeUnit
string
AnyOfString
object
Evaluates to boolean.
2 properties
Condition.Combination
object
2 properties
IsNotListMember
object
Evaluates to boolean.
1 property
AnyOfNumber
object
Evaluates to boolean.
2 properties
SegmentDefinition
object
2 properties
Continuation.Combination
object
2 properties
Condition
object
3 properties
TrackedData
object
3 properties
IsListMember
object
Evaluates to boolean.
1 property
StringLiteral
object
Evaluates to string.
1 property
Key
object
Must be unique within a SegmentDefinition.
1 property
Comparator
string
PathReference
object
Evaluates to type of referenced field.
1 property
IsNotMissing
object
Evaluates to boolean.
1 property
CustomerCondition
object
1 property
Expression.Combination
object
Evaluates to boolean.
2 properties
FalseOrMissing
object
Evaluates to boolean.
1 property
NoneOfNumber
object
Evaluates to boolean.
2 properties
IsMissing
object
Evaluates to boolean.
1 property
NumberLiteral
object
Evaluates to number.
1 property
LikeNoneOfString
object
Evaluates to boolean.
2 properties
TruncateTime
object
Evaluates to number (epoch seconds).
3 properties
Conjunction
string
UninstallSegmentResponse
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zaius-realtimesegments-api-openapi.yml Raw ↑

Other APIs Zaius publishes across the network.

Zaius Compliance API
Zaius Consent API
Zaius Consent (Legacy) API
Zaius Customers API
Zaius Events API
Zaius Exports API
Zaius Fields schema API
Zaius Identifiers API
Zaius Lists API
Zaius Object schema API
Zaius Objects API
Zaius Orders API