Skip to content
Events and Alarms/
/
Get Events Meta Data

Events and Alarms (v0.0.3)

Download OpenAPI description
Download PDF
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud

Event

APIs for retrieving and managing event data.

Operations

Get Historical Clients

Request

Get historical client list information grouped by client MAC address.

Body
required
searchStringstring

Search string provided by user.

searchTargetFieldsArray of stringsunique

Fields to be searched.

fieldsArray of stringsunique

Fields to be returned in response.

sortFieldstring

Field to sort the results on.

sortOrderstring

The order in which results should be sorted.

Enum"asc""desc"
pageinteger(int32)

Page number for pagination.

pageSizeinteger(int32)

Number of records per page.

filtersobject

Users need to pass a list of string or string as map values.

detailLevelstring

Detail level of the event data.

{
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "fields": [
    "string"
  ],
  "sortField": "string",
  "sortOrder": "asc",
  "page": 0,
  "pageSize": 0,
  "filters": {
    "property1": null,
    "property2": null
  },
  "detailLevel": "string"
}

Responses

successful operation

Body
requestIdstring

Request ID associated with the error.

errorobject(Error)

Detailed information about the error that occurred.

errorsArray of objects(Error)

A collection of error objects if multiple errors occurred.

dataArray of objects

Event information.

fieldsArray of strings

Relevant fields.

totalCountinteger(int32)

The total number of events matching the query.

subsequentQueriesArray of objects

Subsequent queries.

messagestring

A human-readable message describing any error that occurred.

Response
{
  "requestId": "string",
  "error": {
    "code": "string",
    "message": "string",
    "reason": "string",
    "suggestion": "string"
  },
  "errors": [
    { … }
  ],
  "data": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "subsequentQueries": [
    { … }
  ],
  "message": "string"
}

Get Events

Request

Get event list information.

Body
required
searchStringstring

Search string provided by user.

searchTargetFieldsArray of stringsunique

Fields to be searched.

fieldsArray of stringsunique

Fields to be returned in response.

sortFieldstring

Field to sort the results on.

sortOrderstring

The order in which results should be sorted.

Enum"asc""desc"
pageinteger(int32)

Page number for pagination.

pageSizeinteger(int32)

Number of records per page.

filtersobject

Users need to pass a list of string or string as map values.

detailLevelstring

Detail level of the event data.

{
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "fields": [
    "string"
  ],
  "sortField": "string",
  "sortOrder": "asc",
  "page": 0,
  "pageSize": 0,
  "filters": {
    "property1": null,
    "property2": null
  },
  "detailLevel": "string"
}

Responses

successful operation

Body
requestIdstring

Request ID associated with the error.

errorobject(Error)

Detailed information about the error that occurred.

errorsArray of objects(Error)

A collection of error objects if multiple errors occurred.

dataArray of objects

Event information.

fieldsArray of strings

Relevant fields.

totalCountinteger(int32)

The total number of events matching the query.

subsequentQueriesArray of objects

Subsequent queries.

messagestring

A human-readable message describing any error that occurred.

Response
{
  "requestId": "string",
  "error": {
    "code": "string",
    "message": "string",
    "reason": "string",
    "suggestion": "string"
  },
  "errors": [
    { … }
  ],
  "data": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "subsequentQueries": [
    { … }
  ],
  "message": "string"
}

Get Events Meta Data

Request

Get events with venue, access point and network data.

Body
required
fieldsArray of stringsunique

Fields to be returned in response.

filtersobject

Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

{
  "fields": [
    "string"
  ],
  "filters": {
    "property1": null,
    "property2": null
  }
}

Responses

successful operation

Body
requestIdstring

Request ID associated with the error.

errorobject(Error)

Detailed information about the error that occurred.

errorsArray of objects(Error)

A collection of error objects if multiple errors occurred.

dataArray of objects

Event information.

fieldsArray of strings

Relevant fields.

totalCountinteger(int32)

The total number of events matching the query.

subsequentQueriesArray of objects

Subsequent queries.

messagestring

A human-readable message describing any error that occurred.

Response
{
  "requestId": "string",
  "error": {
    "code": "string",
    "message": "string",
    "reason": "string",
    "suggestion": "string"
  },
  "errors": [
    { … }
  ],
  "data": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "subsequentQueries": [
    { … }
  ],
  "message": "string"
}

Get Events Details Data

Request

Get events details with venue, access point and network data.

Body
required
fieldsArray of stringsunique

Fields to be returned in response.

filtersobject

Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

{
  "fields": [
    "string"
  ],
  "filters": {
    "property1": null,
    "property2": null
  }
}

Responses

successful operation

Body
requestIdstring

Request ID associated with the error.

errorobject(Error)

Detailed information about the error that occurred.

errorsArray of objects(Error)

A collection of error objects if multiple errors occurred.

dataArray of objects

Event information.

fieldsArray of strings

Relevant fields.

totalCountinteger(int32)

The total number of events matching the query.

subsequentQueriesArray of objects

Subsequent queries.

messagestring

A human-readable message describing any error that occurred.

Response
{
  "requestId": "string",
  "error": {
    "code": "string",
    "message": "string",
    "reason": "string",
    "suggestion": "string"
  },
  "errors": [
    { … }
  ],
  "data": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "subsequentQueries": [
    { … }
  ],
  "message": "string"
}

Export Events Within Date Range

Request

Export specific events within a date range.

Body
required
matchFieldsArray of objects(Match Field)

Match fields for the query.

mustNotMatchFieldsArray of objects(Must Not Match Field)

Must not match fields for the query.

tenantIdstring

The unique identifier for the tenant.

rangeFilterobject(Range Filter)

Range filter for the query.

pageinteger(int32)

Page number for pagination.

pageSizeinteger(int32)

Number of records per page.

sortFieldstring

Field to sort the results on.

sortOrderstring

The order in which results should be sorted.

Enum"asc""desc"
fieldsArray of stringsunique

Fields to be returned in response.

searchTargetFieldsArray of strings

Fields to be searched.

searchStringstring

Search string provided by user.

filtersobject

Filters for the query.

clientTimeZonestring

Client time zone.

clientDateFormatstring

Client date format.

detailLevelstring

Detail level of the event data.

isSupportboolean

Is support user or not.

eventsPeriodForExportobject

Events period for export.

termFieldobject(Term Field)

Term field for the query.

groupBystring

Group by field.

{
  "matchFields": [
    { … }
  ],
  "mustNotMatchFields": [
    { … }
  ],
  "tenantId": "string",
  "rangeFilter": {
    "field": "string",
    "gte": "string",
    "lte": "string"
  },
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "asc",
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "clientTimeZone": "string",
  "clientDateFormat": "string",
  "detailLevel": "string",
  "isSupport": true,
  "eventsPeriodForExport": {
    "property1": "string",
    "property2": "string"
  },
  "termField": {
    "field": "string",
    "value": "string"
  },
  "groupBy": "string"
}

Responses

successful operation

Bodyapplication/json
string

CSV file stream containing exported events

Response
application/json
"string"

Get Admin Members Last Logins

Request

Get admin members last logins.

Path
adminGroupIdstringrequired

Admin Group Id

No request payload

Responses

successful operation

Body
requestIdstring

Request ID associated with the error.

errorobject(Error)

Detailed information about the error that occurred.

errorsArray of objects(Error)

A collection of error objects if multiple errors occurred.

countinteger(int32)

Number of members in a group.

lastLoginListArray of objects(Last Login)

Member's last login list.

Response
{
  "requestId": "string",
  "error": {
    "code": "string",
    "message": "string",
    "reason": "string",
    "suggestion": "string"
  },
  "errors": [
    { … }
  ],
  "count": 0,
  "lastLoginList": [
    { … }
  ]
}

Alarm

APIs for retrieving and managing alarm data.

Operations

Group Members Last login Event

Operations