Skip to main content

API Dashboard

Use the API dashboard to inspect your recent API requests and webhooks.

The data should help you debug your app, and understand what is happening on the Legalesign side. In addition, you can easily check and review whether any requests are throwing 4xx and 5xx errors.

See also troubleshooting for debugging help.

Get started at https://logs.legalesign.com.

Use the login credentials for your API key-holding account.

Layout

The image below shows the dashboard when you arrive. There are two main tabs, requests and webhooks. In requests, click one of the time period buttons to query for your API requests over the last day, week or fortnight.

main layout

Time graphs & requests

After you click a time period your requests will be graphed. In the image below, the graphs show API requests over the last week.

The graphs, from the left, show the overall count of requests, requests filtered for 4XX status, and then for 5XX status.

From the image below, this account made 14 requests two days ago and one yesterday. There are no 4XX or 5XX requests over the last week.

1 week graph

Click a node on the graph to list the requests for that period. In this case, clicking the right hand node then shows the 1 request in the table below the graphs, with its datetime and http status.

requests link

info

Note the dashboard is not realtime. Your latest API requests may take a minute or so to arrive.

To dig into the details of a request click the 'Show' button. All the logged details pop up in a scrollable modal.

log details link

Webhooks

Click the webhooks tab to see all your webhooks events (up to 100) over the last 2 weeks.

If you are not receiving your webhooks as expected, check this section. You will see the time the webhook was sent (UTC), the http status received from your server, and the data that was sent to you.

The screenshot below shows several 'all realtime' webhooks being sent to an ngrok address.

webhook

Common webhook issues

403 status - this is most likely your site cross-site request forgery (CSRF) protection. Since a webhook is a POST request you'll need to turn this off for the receiving view.

5XX statuses - your parsing is most likely going wrong. Run the JSON data shown through your code to check it parses as expected.

Learn more about webhooks.