How to get monitoring data
This topic demonstrates how to get and display all of your organization’s monitoring data.
Run this code example from our Quickstart or launcher projects: Bash, C#, Java, Node.js, PHP, PowerShell, Python, or Ruby.
Prerequisites
Running the code in this how-to requires this data:
Step 1. Obtain your OAuth token
To make the API calls shown in this how-to, you need a valid OAuth access token.
Because Docusign Monitor requires that you impersonate a user with admin access to your organization, you must have obtained your access token using JWT Grant and have requested the impersonation scope. For details, see Docusign Monitor Authentication.
Step 2. Construct your API headers
After you have a valid OAuth access token, you are ready to construct the API headers that you will pass to the API call. Construct your headers like this, but make sure to substitute your valid OAuth access token for {ACCESS_TOKEN}.
Step 3. Get monitoring data
Make a GET request to the DataSet:getStream endpoint to get your monitoring data. Because your organization may have large amounts of data, you can use the limit query parameter to specify the maximum number of records each call will return (2,000 in the example shown here) and a cursor value to continue the query from where the previous one left off.
In this example, we return and display chunks of monitoring data, record the returned cursor value, and use that value to begin the next query until all data has been returned.
Expected response
If your API call is successful, you should see a JSON response similar to this.
The sample response shows only the results of the final three query loops; the first loops (and the body of the data returned) are omitted due to lack of space. You can see the structure of the returned JSON in Tracking data and handling alerts.
Next steps
- Run this code example from our Quickstart or launcher projects: Bash, C#, Java, Node.js, PHP, PowerShell, Python, or Ruby.
- Learn the context of getting tracking data.
- Find out more about Docusign Monitor Authentication.
- See Best practices for handling alerts.
- See Go-Live to see the Monitor API endpoint base path for the production environment.