Insights
Your Insights tab gives you a general view of your API data. From this main hub, you can quickly see your API requests, signature request statuses, and signature request usage collated into graphs. You can customize your timeline view of this data by data type, date range, and error status (API error distribution, endpoint, or HTTP status) using the dropdown at the top of the page. You can also check logs for app and account activity.
You can also see your quota usage (remaining signature requests) and basic billing information on the Insights tab.
Signature request status
You can see document IDs, signature request statuses, and dates and times of events in the Signature request status tab. The information on this page can be filtered by date and signature request status by using the dropdown at the top of the page.
App callbacks
The App callback tab helps you set up and monitor your user interface (UI) interactions, giving you a detailed picture of embedded feature engagement.
App callbacks are triggered when a programmed action (aka an “event”) associated with a specific app occurs. The information collated in this tab will show embedded requests only.
Learn more about callbacks and how to set them up in your Dropbox API Dashboard.
Account callbacks
The Account callback tab helps you set up and monitor your server events for a streamlined workflow and minimal lag time.
Account callbacks notify your app when an event involving your account occurs by sending the event payload to your account callback url — in other words, when the entirety of the data contained within the event is generated. You can filter your account callbacks by date and event type by clicking on the dropdown menus.
You can set your account callback URL by using the account API call or manually on the Settings page.
Learn more about callbacks and how to set them up in your Dropbox API Dashboard.
API requests
The API requests tab will give you a snapshot of the functionality of your sent requests so you can quickly search for and address any request errors.
API requests can be filtered by date, HTTP status, method, and endpoint by using the dropdown at the top of the page.
The HTTP codes represent the status of the interactions between your browser and the server. Using your API Dashboard, you can filter requests by HTTP status code to streamline which requests need attention and which are working as intended.
Here’s how to understand your HTTP statuses:
- An Informational status means that the server has not yet completed the request (codes 100-199).
- A Success status means the server request was completed without error (codes 200-299).
- A Redirectional status indicates that the request was received, but then redirected elsewhere (codes 300-399).
- A Client error status means that the page couldn’t be reached. This is an error from the side of the website and usually occurs when the page doesn’t exist on the site (codes 400-499).
- A Server error status is when a valid request was made but the server failed to complete the request as expected (codes 500-599).
You can also filter signature requests by method:
- GET is used to retrieve or read a resource.
- POST is used to create a new resource.
- DELETE is used to delete the whole of a resource.
- PUT is used to modify the whole resource.
- PATCH is used to modify part of the resource.
To filter request by endpoints:
- Create any other request parameter (date, HTTP status, method) you need for this view.
- Click Endpoint.
- Click Custom.
- Click the box next to any applicable endpoint.
- Click Apply.
The list of endpoints is available in the signature requests overview.
Signature request usage
Signature requests can be used to reference request-specific data including the names and email addresses of signers, custom fields, metadata, response data, and timestamps for when the request was created and completed. You can filter usage data by date and client ID.
