Data Extraction APIs

Introduction

This section explains how to extract data from the Gear Studio platform using the HTTP API, such as:

• Alerts: the API allows extracting the definition of all alerts created in the platform, filtering them in different ways.
• Alarms: the API allows extracting all alarms recorded in the platform, historically, filtering them in different ways.
• Endpoint data: the API allows extracting all information associated with endpoints, historically, filtering it in different ways.
• Geozones: the API allows extracting the list of geozones configured for each client, including the list of vehicles contained within them.

Getting Started

Creating an access token

As with any other HTTP integration, it is necessary to create an access token. This page contains more information about managing access tokens. Access tokens allow controlling the access and permissions used for any operation.

Authentication using an access token

In all APIs, the access token can be sent as part of the header, using an Authorization header, as shown below:

Authorization: Bearer e54e0911-ece3-4b7a-b84d-afc01dfa81f1

Alternatively, when it is not possible to send the token through the Authorization header, the access token can be sent as part of the URL, through the "accessToken" parameter, as in the following example:

https://gear.cloud.studio/api/v2/alarms?accessToken=e54e0911-ece3-4b7a-b84d-afc01dfa81f1&clientID=4&maxCount=10

API Execution

To execute the API, review each of the following sections, which contain the related information:

• Extracting alerts.
• Extracting alarms.
• Extracting endpoint data.
• Extracting geozone data.