Lightstep Public API

Lightstep x[PM] JSON APIs
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0
BasePath:/public/v0.1
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ]

Table of Contents

Conditions

Dashboards

Projects

Services

Snapshots

Streams

Test

Traces

WorkflowLinks

Conditions

Up
delete /{organization}/projects/{project}/conditions/{condition-id}
Delete Condition (deleteConditionID)
Deletes an existing condition

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
condition-id (required)
Path Parameter — Identifier of the condition to delete

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Condition was successfully deleted

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

Up
get /{organization}/projects/{project}/conditions/{condition-id}
Get Condition (getConditionID)
Returns information about a specific condition

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
condition-id (required)
Path Parameter — Condition identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON-formatted data about the given condition

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

500

The condition identifier is not valid

Up
get /{organization}/projects/{project}/conditions/{condition-id}/status
Get Condition Status (getConditionStatusID)
Returns status information about a specific condition

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
condition-id (required)
Path Parameter — Condition identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON-formatted data about the status of the given condition

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

500

The condition identifier is not valid

Up
get /{organization}/projects/{project}/searches/{stream-id}/conditions
List Conditions for Stream (listConditionsForStreamID)
Returns information about all conditions in a specific stream

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
stream-id (required)
Path Parameter — Stream identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON-formatted metadata about all conditions in the given stream

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

500

The stream identifier is not valid

Up
get /{organization}/projects/{project}/conditions
List Conditions (listConditionsID)
Returns information about all conditions in a project

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON-formatted metadata about all conditions in the project

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

Up
patch /{organization}/projects/{project}/conditions/{condition-id}
Update Condition (patchConditionID)
Modifies the settings for an existing condition

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
condition-id (required)
Path Parameter — Identifier of the condition to modify

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

data conditionRequestBody (required)
Body Parameter — Condition definition

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The condition was updated successfully

400

One or more parameter(s) are not valid

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

500

Condition identifier not found

Up
post /{organization}/projects/{project}/conditions
Create Condition (postConditionID)
Creates a new condition

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

data conditionRequestBody (required)
Body Parameter — Condition definition

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The condition was created successfully

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

Dashboards

Up
post /{organization}/projects/{project}/dashboards
Create Dashboard (createDashboardID)
Creates a new dashboard, with inline stream definitions. Automatically creates the necessary streams if they do not already exist.

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

data dashboardRequestBody (required)
Body Parameter — Dashboard definition

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The dashboard was created (or updated) successfully

400

No organization parameter provided

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

Up
delete /{organization}/projects/{project}/dashboard/{dashboard-id}
Delete Dashboard (deleteDashboardID)
Deletes an existing dashboard. Does not delete any streams.

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
dashboard-id (required)
Path Parameter — Identifier of the dashboard to delete

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Dashboard was successfully deleted

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

500

Dashboard identifier not found

Up
get /{organization}/projects/{project}/dashboards/{dashboard-id}
Get Dashboard (getDashboardID)
Returns complete information about a specific dashboard, including stream definitions.

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
dashboard-id (required)
Path Parameter — Dashboard identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON-formatted metadata about the dashboard

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name or dashboard ID is not found

Up
get /{organization}/projects/{project}/dashboards
List Dashboards (listDashboardsID)
Returns information about all dashboards in a project

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON-formatted metadata about all dashboards in the project

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

Up
patch /{organization}/projects/{project}/dashboards/{dashboard-id}
Update Dashboard (patchDashboardID)
Updates the dashboard with a new name (if applicable), and replaces the set of streams on the dashboard. Streams that are removed from the dashboard will not be deleted from the project.

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
dashboard-id (required)
Path Parameter — Identifier of the dashboard to modify

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

data dashboardRequestBody (required)
Body Parameter — Dashboard definition

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The dashboard was updated successfully

400

One or more parameter(s) are not valid

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

500

Dashboard identifier not found

Projects

Up
get /{organization}/projects/{project}
Get Project (getProjectID)
Returns information about a specific project

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON-formatted metadata about all projects in the project

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

Up
get /{organization}/projects
List Projects (listProjectsID)
Returns information about all projects in an organization

Path parameters

organization (required)
Path Parameter — Name of the customer organization

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON-formatted metadata about all projects in the organization

400

No organization parameter provided

401

The API Key does not provide access to this resource, or the organization name does not exist

Services

Up
get /{organization}/projects/{project}/directory/services
List Services (listServicesID)
Returns all reporting services for a project

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

limit (optional)
Query Parameter — Service object count limit in paginated response
offset (optional)
Query Parameter — Service object offset in paginated response

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON-formatted metadata about all services reporting in the project

400

One or more parameter(s) are not valid

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

Snapshots

Up
post /{organization}/projects/{project}/snapshots
Create Snapshot (createSnapshot)
Creates a new Snapshot for the provided query

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

data snapshotCreate (required)
Body Parameter — Span query to create a snapshot for

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The snapshot was created successfully

400

Query parameters invalid

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

429

Snapshot creation exceeded rate limit

Streams

Up
delete /{organization}/projects/{project}/searches/{stream-id}
Delete Stream (deleteSearchID)
Deletes an existing stream

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
stream-id (required)
Path Parameter — Identifier of the stream to delete

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Stream was successfully deleted

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

Up
get /{organization}/projects/{project}/searches/{stream-id}
Get Stream (getStreamID)
Returns information about a specific stream

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
stream-id (required)
Path Parameter — Stream identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON-formatted data about the given stream

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

500

The stream identifier is not valid

Up
get /{organization}/projects/{project}/searches
List Streams (listStreamsID)
Returns information about all streams in a project

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON-formatted metadata about all streams in the project

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

Up
patch /{organization}/projects/{project}/searches/{stream-id}
Update Stream (patchSearchID)
Modifies the settings for an existing stream

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
stream-id (required)
Path Parameter — Identifier of the stream to modify

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

data createOrUpdateBody (required)
Body Parameter — Stream definition

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The stream was created (or updated) successfully

400

One or more parameter(s) are not valid

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

500

Stream identifier not found

Up
post /{organization}/projects/{project}/searches
Create Stream (postSearchID)
Creates a new stream (or updates an existing stream if the query is identical)

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

data createOrUpdateBody (required)
Body Parameter — Stream definition

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The stream was created (or updated) successfully

401

The API Key does not provide access to this resource, or the organization name does not exist

404

Project name is not found

Up
get /{organization}/projects/{project}/searches/{stream-id}/timeseries
Timeseries (timeseriesID)
Returns timeseries data for a stream

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the project that contains the stream
stream-id (required)
Path Parameter — The ID of the stream to fetch timeseries data for

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

oldest-time (required)
Query Parameter — Beginning of the time range being queried, e.g. 2018-01-20T02:30:00-08:00 format: date-time
youngest-time (required)
Query Parameter — End of the time range being queried, e.g. 2018-01-22T06:30:00-08:00 format: date-time
resolution-ms (required)
Query Parameter — Length of time represented by each "point" (time window) in the timeseries, in milliseconds. The minimum value (highest resolution data) for this parameter is 60000 (representing 1 minute of data per point). Larger values will result in latency distributions being merged. default: 60000
include-exemplars (optional)
Query Parameter — Boolean value that indicates whether the response should include example trace information for each time window. 0=false, 1=true default: 0
include-ops-counts (optional)
Query Parameter — Indicates whether the response should specify the number of spans represented by each time window. 0=false, 1=true default: 0
include-error-counts (optional)
Query Parameter — Indicates whether the response should specify the number of spans with errors in each time window. 0=false, 1=true default: 0
percentile (optional)
Query Parameter — A (possibly) repeated field that indicates what latency percentiles to return for each time window, if any. Valid for values (0, 99.99].

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON representation of a timeseries

400

One or more of the request parameter(s) is not valid

401

The API Key does not provide access to this resource

404

Project name is not found

500

Stream ID is not valid, or other internal error

Test

Up
get /{organization}/test
Read Test (testReadID)
A read-only endpoint for testing your authentication key.

Path parameters

organization (required)
Path Parameter — Name of the customer organization

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK!

401

Unauthorized

Up
post /{organization}/test
Write Test (testWriteID)
A write endpoint for testing your authentication key.

Path parameters

organization (required)
Path Parameter — Name of the customer organization

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK!

401

Unauthorized

Traces

Up
get /{organization}/projects/{project}/stored-traces
Stored Traces (storedTracesID)
Returns complete traces that have already been assembled and stored

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the project that the trace belongs to

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

span-id (required)
Query Parameter — Key that uniquely identifies a stored trace

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON representation of a stored trace

400

Missing required parameter

404

No stored traces found

WorkflowLinks

Up
post /{organization}/projects/{project}/wf_links
Create Workflow Link (createWorkflowLinkID)
Creates a new workflow link. Links within a project must have a unique combination of Name and URL. Admin or Member privileges are required to created workflow links.

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

data externalLinkRequestBody (required)
Body Parameter — Workflow Link definition

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The workflow link was created successfully

400

Bad request - could not decode JSON request, or a parameter (name, URL, or Rules) is missing

401

The API Key does not provide access to this resource

403

Unsupported request to create resource - links within the same project cannot have the same name and URL.

404

Organization or project not found

Up
delete /{organization}/projects/{project}/wf_links/{link-id}
Delete Workflow Link (deleteWorkflowLinkID)
Deletes an existing workflow link.

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
link-id (required)
Path Parameter — Identifier of the workflow link to delete

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

The workflow link was successfully deleted

401

The API Key does not provide access to this resource

404

Organization, project name, or workflow link ID is not found

Up
get /{organization}/projects/{project}/wf_links/{link-id}
Get Workflow Link (getWorkflowLinkID)
Returns information on a specific workflow link definition within a project.

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
link-id (required)
Path Parameter — Workflow Link identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON-formatted metadata about the workflow link

401

The API Key does not provide access to this resource

404

Organization, project name, or workflow link ID is not found

Up
get /{organization}/projects/{project}/wf_links
List Workflow Links (listWorkflowLinksID)
Returns information on all workflow link definitions within a project

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON-formatted metadata about all workflow link definitions in the project

401

The API Key does not provide access to this resource

404

Organization or project not found

Up
patch /{organization}/projects/{project}/wf_links/{link-id}
Update Workflow Link (patchWorkflowLinkID)
Updates the workflow link with a new name or URL (if applicable), or replaces the set of rules on the workflow link. If a non-empty parameter (i.e., name, URL, or Rules) is provided, the field will will be overwritten with the new value. Links within a project must have a unique combination of name and URL. Admin or Member privileges are required to created workflow links.

Path parameters

organization (required)
Path Parameter — Name of the customer organization
project (required)
Path Parameter — Name of the customer project
link-id (required)
Path Parameter — Identifier of the workflow link to modify

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

data externalLinkRequestBody (required)
Body Parameter — Workflow Link definition

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The workflow link was updated successfully

400

Bad request - could not decode JSON request

401

The API Key does not provide access to this resource

403

Unsupported request to create resource - links within the same project cannot have the same name and URL.

404

Organization, project name, or workflow link ID is not found

Models

[ Jump to Methods ]

Table of Contents

  1. Links -
  2. LinksObj -
  3. Micros -
  4. Name -
  5. RelatedResourceObject -
  6. Rules -
  7. URL -
  8. conditionRequest -
  9. conditionRequestAttributes -
  10. conditionRequestBody -
  11. conditionRequestRelationships -
  12. createAccessTokenAttributes -
  13. createAccessTokenBody -
  14. createAccessTokenRequest -
  15. createOrUpdateBody -
  16. createOrUpdateRequest -
  17. createProjectBody -
  18. createProjectRequest -
  19. dashboardAttributes -
  20. dashboardRelationships -
  21. dashboardRequest -
  22. dashboardRequestBody -
  23. externalLinkAttributes -
  24. externalLinkRelationships -
  25. externalLinkRequest -
  26. externalLinkRequestBody -
  27. searchAttributes -
  28. searchRelationships -
  29. searchRequestAttributes -
  30. searchResponse -
  31. snapshotCreate -
  32. snapshotCreate_data -
  33. snapshotCreate_data_attributes -

Links - Up

LinksObj - Up

links (optional)

Micros - Up

Name - Up

RelatedResourceObject - Up

id
String Unique identifier of the related resource
type
String Valid values: Stream resource: "search" Condition resource: "condition"

Rules - Up

URL - Up

conditionRequest - Up

attributes (optional)
id (optional)
String Unique identifier of the described resource Do not populate this field for POST or PATCH requests, use path parameters instead
relationships (optional)
type
String Valid values: Stream operations: "search" Condition operations: "condition"

conditionRequestAttributes - Up

custom-data (optional)
eval-window-ms (optional)
Long format: int64
expression (optional)
name (optional)

conditionRequestBody - Up

data (optional)

conditionRequestRelationships - Up

search (optional)

createAccessTokenAttributes - Up

name (optional)

createAccessTokenBody - Up

data (optional)

createAccessTokenRequest - Up

attributes (optional)

createOrUpdateBody - Up

data (optional)

createOrUpdateRequest - Up

attributes
id (optional)
String Unique identifier of the described resource Do not populate this field for POST or PATCH requests, use path parameters instead
type
String Valid values: Stream operations: "search" Condition operations: "condition"

createProjectBody - Up

data (optional)

createProjectRequest - Up

name

dashboardAttributes - Up

name
String Name for the dashboard (free-form string)
searches (optional)
array[searchResponse] Searches to be added to the dashboard. If the search exists already, include the ID. If it does not, do not include an ID. A new search will be created

dashboardRelationships - Up

project (optional)

dashboardRequest - Up

attributes (optional)
id (optional)
String Unique identifier of the described resource Do not populate this field for POST or PATCH requests, use path parameters instead
relationships (optional)
type
String Valid values: Stream operations: "search" Condition operations: "condition"

dashboardRequestBody - Up

data (optional)

externalLinkAttributes - Up

created_by (optional)
last_clicked_micros (optional)
last_edited_micros (optional)
name (optional)
rules (optional)
url (optional)

externalLinkRelationships - Up

project (optional)

externalLinkRequest - Up

attributes (optional)
id (optional)
String Unique identifier of the described resource Do not populate this field for POST or PATCH requests, use path parameters instead
relationships (optional)
type
String Valid values: Stream operations: "search" Condition operations: "condition"

externalLinkRequestBody - Up

data (optional)

searchAttributes - Up

custom-data (optional)
map[String, Object] Custom JSON data that can be set by an end user and will be included in notifications.
name
String Name for the stream (free-form string)
query (optional)
String The query string itself (see Query Syntax section for details). Once a search has been created, this string cannot be modified. Required when creating new streams.

searchRelationships - Up

conditions (optional)
project (optional)

searchRequestAttributes - Up

custom_data (optional)
map[String, Object] Custom JSON data that can be set by an end user and will be included in notifications.
name
String Name for the stream (free-form string)
query (optional)
String The query string itself (see Query Syntax section for details). Once a search has been created, this string cannot be modified. Required when creating new streams.

searchResponse - Up

attributes (optional)
id (optional)
String Unique identifier of the described resource Do not populate this field for POST or PATCH requests, use path parameters instead
links (optional)
relationships (optional)
type
String Valid values: Stream operations: "search" Condition operations: "condition"

snapshotCreate - Up

data (optional)

snapshotCreate_data - Up

attributes (optional)

snapshotCreate_data_attributes - Up

query
String The query string itself (see Query Syntax section for details).