API Status

With API Status, you can check key information about the availability of your API resources in your Developer Portal.

This feature is only available for Sensedia gateways.

API Status Screen

Accessing your API information

Follow these steps to view your API information.

  1. Log in to your Developer Portal and click on the top right menu [APIs > Status].
    You can also use the direct link: https://{your-portal}/status.
    API Status screen detail with menu highlighted

  2. Select a Gateway.
    API Status screen detail with Gateway highlighted

  3. Click the magnifying glass icon over a paper representing the view action icon in the ACTIONS column for the desired API.
    See also the description of each column.

  4. The selected API’s information will be displayed on the screen.
    See the description of the fields displayed.

You need to be logged in to access API Status.

Table Details

The API Status screen displays a table with the following columns:

  • Method: HTTP method used in the call (e.g., GET, POST, PUT, DELETE).

  • Operation description: Description of the operation.

  • Calls: Number of calls made.

  • API: API name.

  • Actions: Actions available for the selected API.

    • magnifying glass icon over a paper representing the view action Displays details about the selected API.

API Availability modal screen

The API Availability modal screen displays the following information:

API in last hour

  • (icon): API availability indicator:

    • green Availability greater than 90%

    • red Availability less than 89%

  • Method: HTTP method used in the call (e.g., GET, POST, PUT, DELETE).

  • Operation description: Description of the operation.

  • Availability (%): API availability percentage.

  • Response time (ms): Average API response time in milliseconds.

API Status - History

  • Period: Time period during which the API was monitored:

    • Last day: Last day

    • Last week: Last week

    • Last month: Last month

  • Availability (%): API availability percentage.

  • Response time (ms): Average API response time in milliseconds.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]