This guide will walk you through how to access and utilise the sessions and API reports in your dashboard.
Step 1: Logging In
Open your web browser and log in with your username and password. You'll land on your dashboard page.To access session reports and statistics, you need to have run at least one session. Once you've initiated a session, you'll be able to access and view your session reports.
If you haven't run a session yet, start a session. You can check the guide How to Activate/Run a Pre-defined Extractor?
Step 2: Accessing The Reports
To access your statistics, there are two methods you can follow:
Dashboard Method:
Go to your dashboard.
Look for "Sessions Statistics" and "API Statistics." These sections will provide you with an overview of your usage.
On the dashboard overview; for session statistics, the X-axis shows the dates, the left Y-axis shows the sum of the rows you have extracted on that day, the right Y-axis shows the count of sessions. For API statistics, the X-axis shows the date, the Y-axis shows the sum of the requests you have sent on that day.
If you want to view more detailed session information, you can click on "View more" within the respective section.
Usage Method:
On the left side of the page, you'll find a navigation menu.
Click on "Usage" within the navigation menu.
From the "Usage" section, you can access the "Sessions Report" to get more comprehensive details about your sessions.
Step 3: Navigating the Session Reports
In the left top corner, you can see all the sessions you have run and all the rows you have extracted.
You might have to scroll a bit to see the session you want. The reports are sorted based on the number of sessions run for a PDE.
The Sessions page displays a graph. The X-axis shows dates and the Y-axis shows the number of rows. Each grey column shows the number rows that have been extracted.
In the top right corner of the graph, you will find options to filter by time gap and time range. You can specify the time frame you want to view. Adjusting the time settings updates the graph accordingly.
You can also hover your mouse over on the graph to view specific data points for each date.
Step 3: Navigating the API Reports
In the left top corner, you can see all the data that came back successfully and unsuccessfully.
In here, the reports are sorted based on the number of successful datas.
In the API usage graphs, the X-axis represents dates, the left Y-axis represents the number of requests that have been sent and the right Y-axis shows the session count.
Green shows the number of responses that came back with data and grey shows the number of responses that came back with no data. Red line shows the success rate of the requests.
In the top right corner of the graph, you will find options to filter by time gap and time range. You can specify the time frame you want to view. Adjusting the time settings updates the graph accordingly.
You can also hover your mouse over on the graph to view specific data points for each date.
