10 min read.
The Integration View is designed to give detailed information on the status of the integrations made against an Integration Template by your end-users.
On the Templates page, hover over any template’s stats and it will show a clickable option to View Integrations as shown below. If there are no integrations available for a template, the stats will be unclickable.
Upon clicking on View Integrations you will be taken to the Integration View page as shown below.
Here you can see all of your end-users and detailed information regarding all the integrations they have made against the Integration Template you are currently viewing the Integration Details for. This information includes the name of the user, their User ID, the number of their integrations, their status as well as the number of tasks executed.
On the top of the Integration View screen, you will see the Template ID and name along with its stats. There is a Back sign next to the Template ID which takes you back to the Templates page or any page that you were previously on, this remains true throughout all screens of the Integration View feature.
In the center of the page, you can see the name, image, and ID of all the end-users who have made integrations using the template you are on. By default, the users are sorted by most recent. If there is no image available for a user, a default image will be shown. If there is no name for the user, then the user ID will be shown as the username.
Apart from user details, you can also see the number of integrations made by a user; the number of tasks consumed by the user; the task limit for each user, and the status of the user which can be: Active, Inactive, Paused, Auth Missing or Creation Failed:
- Active users have at least one active integration.
- Inactive users have no integrations.
- Paused users are those who have reached their task limit.
- Auth Missing status of the user indicates that their integration is missing authorization.
- Creation Failed: If the user’s integration creation has failed the status will appear as Creation Failed.
You can see the View More option at the bottom, every time you click on this, more items will be loaded. If you click on a particular ID, it will be copied to the clipboard.
Clicking on an end-user will allow you to see their integrations with the most recent integrations appearing on the top along with a user-health bar, as shown below.
The health bar appears throughout the integration view. It is a quick way to view the status of your integrations and it has five different levels denoted by different colors.
- Green is for 2xx Success which means that the request was successfully received, understood, and accepted.
- Yellow is for Loop Prevented which means we received an event from a service which would’ve caused an infinite loop
- Blue is for 3xx Redirection which is for when the server asks to go to another URL.
- Purple is for 4xx Client Errors which means that the request contains bad syntax or cannot be fulfilled.
- Pink is for 5xx Server Errors which means that the server has failed to fulfill a request.
In the Template view, your health bar shows the aggregate status of all runs inside that template. Here you can see all of your end users and detailed information regarding all the integrations they have made against the Integration Template you are currently viewing the Integration Details for. This information includes the name of the user, their User ID, the number of their integrations, their status as well as the number of tasks they have performed.
In the User view, your health bar shows the aggregate status of all runs under that user. A run means to execute a program or to operate. In this case a run is any flow in a template, for example, an initial import is one run, creating a contact is another run, and so on.
In the Integration view, it will show an aggregate for all the runs inside that integration. Inside a template, it will show aggregate status for all the runs inside that template.
In the run view, it will show the aggregate status of all the steps performed under a particular run.
Hovering over a point in the bar will show the labels (e.g. 3xx Redirection) for the total number of occurrences and their percentage. Clicking the bar will lead to a filtered view of that status code where you will be able to see the integration name and ID; tasks consumed by an integration; the status of the integrations and the number of runs per integration. The status of your integrations can be active, inactive, or paused.
Integration level view
Clicking on an integration will take you to its detail page as shown below. Here you can see the details of a single integration that a particular user has setup, it includes the details of all the runs performed within that integration, when a particular run occurred, the number of tasks within that run, the duration of the entire run, link to that run’s logs and the status of the run.
At the top of the page, you can see the Integration name and the ID. You can also set a time frame to show only the runs during that time from the dropdown filters available on the right. The dropdown options include Last hour, Last 6 hours, Last 24 hours, Last 7 days (default), No time limit, Custom, Jump to time, and From the start. Selecting the Custom range will load two dropdowns on the left where you can select your custom dates, as shown below.
The filter to its left as shown in the image below is also a dropdown that allows you to select between Show all, Failed only, Successful only, Setup steps only, Polls only, Scheduled steps only, Autohooks only, and Triggers.
The dropdown to the left of this one is for showing or hiding internal steps. Internal steps include implicit actions like loop prevention, serialization, etc.
In the middle section of the page, you can view all the runs that have happened in the particular integration, with the most recent run on the top. You can also view when a run occurred; the number of runs consumed by it, its overall duration, link to logs, and the run’s status. The name of the run is the name of the first step in that run like Setup. In case of a trigger, When is added before the name.
The status for a successful run is 200 in green, the status of an unsuccessful run is red with the error code for the first failed task in the run. Hovering on a status will show the error code description e.g. 503 Service unavailable for an unsuccessful run as shown below.
Hovering on a time period under WHEN will show the exact time stamp for the run, as shown below.
Clicking the ellipsis at the end of a run will give you the option to copy the GUID of the step or view app detail which will show you all the apps and their ID that are part of that run.
Run level view
Clicking on a run will allow you to see its details on the same screen, as shown below.
Here you can see all the tasks inside a run, including all the steps like IF conditions, Loop steps, all actions etc. Failed tasks will be colored red. There will be an iteration counter next to each step showing the number of iterations in that particular step. Five steps will be shown on default but clicking load more iterations will load the next five and so on.
Task level view
Clicking on a task inside a run will load the detail relating to it on the same page, as shown below.
Here you can see all inputs and transformations which are request bodies. A request body is data sent by the client to your API. You can also see raw responses which are response bodies. A response body is the data your API sends to the client. You can see formatted responses as well which is the object output. A formatted response is basically how you collect an answer from a respondent.