API Hosting

The API Hosting section contains a system that records and displays the requests communicated between the OneBlink LcS and the API. In addition to request logging, API Hosting captures metrics and manages scheduled functions. 

TABLE OF CONTENTS

• Logs
  • Reading Logs
  • Searching for Logs
• Scheduled Functions
• Metrics
• OneBlink LcS Environments
• Hosting a custom OneBlink API
• Developer documentation

Logging

The API that is added includes a logging system that records interactions between the LcS and the API. These logs capture detailed information about the actions triggered by specific user activities.

Logs refer to entries in the log list, these are details captured from the interactions in the system connection to the API. For example; When the API has a request, it will record the value and status of what was returned to the logs.

Reading Logs

To read logs of an API, select the "Logs" option:

When searching through logs it is important to note that entire actions undertaken by the user are encapsulated by having 'START', 'END' and 'REPORT' entries listed in the logs, these signify the length of an action that has been recorded:

Each log in the list can be opened to enlarge the full details of the request.

Searching for Logs

To search for logs, this can be done by using the search filter located at the top of the list:

In order to find the specific request you're searching for, its best to use all search filters to get the most accurate result. This can be done by using the Search filter and the Date & Time feature. To narrow down the search, it would be best to first start by using the Dates & Time feature to search within a specific time, making the search quicker.

Depending on what is being searched, some of the main filters to search for would be:

• Submission ID
• External ID
• Status: e.g. "Error"
• User Email

Scheduled Functions

Scheduled Functions refer to a process that allows the execution of a function on an API at specific intervals. 

For example, scheduling a synchronisation task to run daily at 1 PM or scheduling to clear an API's cache. 

A Scheduled Function can be enabled or disabled as needed, can specify the days and times for the task to run, as well as designate an email address to receive notifications once the function has been executed.

Metrics

Metrics measure the amount of requests/errors that have occurred over a selected timespan.

Timeframes can be filtered on: 

• 60 Minutes
• 6 Hours
• 24 Hours
• 7 Days
• 30 Days

There are 3 main metrics that are used to track the overall statistics of an API:

• Total Requests: This tracks the total number of requests.
• 4xx HTTP Errors: Tracks total number of 4xx errors.
• 5xx HTTP Errors: Tracks total number of 5xx errors.

If no errors have occurred, the metric for that error will display as having no responses:

OneBlink LcS Environments

The API hosting environments can be moved over to OneBlink LcS environments in the Hosted API for form migrations. This allows the migration of forms without the need to manually update the Hosted API configuration afterwards.

For example: If a form is in the Demo environment but gets migrated to the Development environment. The Hosted API then can change its current environment to the Development environment in order to more easy track the form without having to change the API itself.

Further information about OneBlink environments can be found in this article.

Custom OneBlink API Hosting

If this is your first foray into utilising the OneBlink API hosting functionalities, please review the following documentation to help get you started.

These are the topics covered to assist you with your development:-

The login command

The OneBlink CLI tool requires the user to authenticate before using any of the services the CLI provides.

API CLI
This document contains a throughout guide on how to configure and develop your hosted API

CDN CLI

The OneBlink CDN CLI allows users to develop features that require the use of a content delivery network

Developer documentation

You can find the documentation for the many robust features that OneBlink provides to its developers, by visiting the OneBlink GitHub page.

Get Help

If you have any questions or would like assistance with setting up your Workflow, please contact us via this support portal or email [email protected]. We are happy to assist in any way we can.