Skip to content

Alpha
Query Traffic Events

Request

In Development

This operation is actively being developed. Breaking changes should be expected.

Please contact us before using this operation.

Returns traffic events from traffic log configurations on the integration. Results are normalized to OCSF Network Activity (class_uid 4001).

Operation ID: networksecurity_query_traffic_events

Security
BearerAuth
Query
metaArray of strings

Add metadata to the response by invoking meta functions. Documentation for meta functions is available. Not all meta functions are available at every endpoint.

limitinteger or null

Number of traffic events to return. Defaults to 100 with a maximum of 200. If a provider has a maximum limit lower than 200, the provider's maximum limit will be used instead. A page may hold fewer results than limit, or none, even when more remain; keep paging until the returned cursor is empty.

filterArray of strings

Filter results by this query. For more information on filtering, refer to our Filtering Guide. Defaults to no filter. If used more than once, the queries are ANDed together. Network security providers support only the time[gte] and time[lte] filters on this endpoint, and any other filter is rejected with a 400 error. When no time filter is supplied, the query covers the most recent hour.

cursorstring or null

Start search from cursor position.

curl
curl -i -X GET \
  https://api.synqly.com/v1/network-security/traffic/log-events \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
cursorstringrequired

Cursor to use to retrieve the next page of results

resultArray of objects(ocsfv1.8.0networkactivityNetworkActivity)required

List of traffic events matching the query.

messagesobject or null(MessagesResponse)

Additional messages from the service response that may be helpful to the client.

metaobject or null(MetaResponse)

Various metadata about the results organized by group, then type, then field.

Response
{ "result": [ { … } ], "cursor": "string", "messages": { "problems": [ … ] }, "meta": { "stats": { … }, "api": { … }, "mapping": { … } } }