{"componentChunkName":"component---src-templates-three-columns-js","path":"/docs/monitor-api/monitor101/tracking-data-handling-alerts/","result":{"pageContext":{"layout":"threeColumns","contentType":"ContentfulAssemblyGuide","data":{"sidebar":{"metadata":{"type":{"data":"sidebarKey"},"sourceUID":{"data":"57EYtLi7eYEtklU0pSMjGd-en-US"},"source":{"data":"CM"},"title":{"data":"Monitor API "},"version":{"data":""},"titleHref":{"data":"/docs/monitor-api/"},"badgeTextOptions":{"data":{"items":[{"version":{"data":""},"text":{"data":""}}]}}},"data":{"menu":{"items":[{"metadata":{},"data":{"text":{"data":"Overview"},"items":null,"href":{"data":"/docs/monitor-api/"},"icon":{},"secondaryText":{"data":"Overview"}}},{"metadata":{},"data":{"text":{"data":"Monitor API 101"},"items":[{"metadata":{},"data":{"text":{"data":"Events and alerts"},"items":null,"href":{"data":"/docs/monitor-api/monitor101/events-alerts"},"icon":{},"secondaryText":{"data":"Monitor API 101%%%%Events and alerts"}}},{"metadata":{},"data":{"text":{"data":"Tracking data and handling alerts"},"items":null,"href":{"data":"/docs/monitor-api/monitor101/tracking-data-handling-alerts"},"icon":{},"secondaryText":{"data":"Monitor API 101%%%%Tracking data and handling alerts"}}},{"metadata":{},"data":{"text":{"data":"Best practices for handling alerts"},"items":null,"href":{"data":"/docs/monitor-api/monitor101/best-practices-handling-alerts"},"icon":{},"secondaryText":{"data":"Monitor API 101%%%%Best practices for handling alerts"}}},{"metadata":{},"data":{"text":{"data":"Authentication"},"items":null,"href":{"data":"/docs/monitor-api/monitor101/auth"},"icon":{},"secondaryText":{"data":"Monitor API 101%%%%Authentication"}}}],"href":{"data":"/docs/monitor-api/monitor101"},"icon":{},"secondaryText":{"data":"Monitor API 101"}}},{"metadata":{},"data":{"text":{"data":"How-to guides"},"items":[{"metadata":{},"data":{"text":{"data":"Code example launchers"},"items":null,"href":{"data":"/docs/monitor-api/how-to/code-launchers/"},"icon":{},"secondaryText":{"data":"How-to guides%%%%Code example launchers"}}},{"metadata":{},"data":{"text":{"data":"Enable Monitor for your organization"},"items":null,"href":{"data":"/docs/monitor-api/how-to/enable-monitor"},"icon":{},"secondaryText":{"data":"How-to guides%%%%Enable Monitor for your organization"}}},{"metadata":{},"data":{"text":{"data":"Get monitoring data"},"items":null,"href":{"data":"/docs/monitor-api/how-to/get-monitoring-data/"},"icon":{},"secondaryText":{"data":"How-to guides%%%%Get monitoring data"}}}],"href":{"data":"/docs/monitor-api/how-to/"},"icon":{},"secondaryText":{"data":"How-to guides"}}},{"metadata":{},"data":{"text":{"data":"SDKs"},"items":null,"href":{"data":"/docs/monitor-api/sdks/"},"icon":{},"secondaryText":{"data":"SDKs"}}},{"metadata":{},"data":{"text":{"data":"Go-Live"},"items":null,"href":{"data":"/docs/monitor-api/go-live"},"icon":{},"secondaryText":{"data":"Go-Live"}}},{"metadata":{},"data":{"text":{"data":"API reference"},"items":null,"href":{"data":"/docs/monitor-api/reference"},"icon":{},"secondaryText":{"data":"API reference"}}}]}}},"body":{"data":{"contentful_id":"44qnZ2k9IDFX1iN2ivlzgK","node_locale":"en-US","name":"Guide Page: Tracking data and handling alerts - /docs/monitor-api/monitor101/tracking-data-handling-alerts","heading":null,"internal":{"type":"ContentfulAssemblyGuide"},"body":[{"id":"dbfb9a8b-e62d-5652-8c8b-48d85ddb1e38","contentful_id":"3ueMD3lR0lb7kiOykLzhBT","node_locale":"en-US","heading":"Tracking data and handling alerts","headingLevel":1,"sectionId":null,"multicolumn":false,"noBorder":false,"backgroundKind":null,"paddingTop":null,"paddingBottom":null,"html":{"html":"<p>You can get activity tracking information for your organization by calling the Docusign Monitor API <a href=\"/docs/monitor-api/reference/monitor/dataset/getstream/\">DataSet:getStream</a> endpoint. This endpoint enables you to download your organization’s data in segments specified by a cursor (a bookmark value returned by a previous <code>DataSet:getStream</code> operation). You can use the resulting dataset to integrate the Monitor API with your existing SIEM software tools and apps.<ul><br/></p><li>In the development (demo) environment, the endpoint is: <br/><code>https://lens-d.docusign.net/api/v2.0/datasets/monitor/stream?cursor={{cursorValue}}&limit={{queryLimit}}</code></li><br/>\n<li>In the production environment, the endpoint is: <br/><code>https://lens.docusign.net/api/v2.0/datasets/monitor/stream?cursor={{cursorValue}}&limit={{queryLimit}}</code></li></ul>"},"sys":{"type":"Entry"},"internal":{"type":"ContentfulAssemblyHtmlSection"}},{"id":"23b26072-c2f5-5839-99f0-2a2b145c9400","contentful_id":"6YBseGPgd7byjx9yrpP3Q","node_locale":"en-US","heading":"Using cursor values","headingLevel":2,"sectionId":null,"multicolumn":true,"noBorder":true,"backgroundKind":null,"paddingTop":null,"paddingBottom":null,"html":{"html":"<ds-column> <p>When you call the <a href=\"/docs/monitor-api/reference/monitor/dataset/getstream/\">DataSet:getStream</a> endpoint, you can supply two parameters, <code>cursor</code> and <code>limit</code>, that determine the subset of the monitoring data that will be returned in the response JSON.</p><p><strong>Note:</strong> To call the Monitor API endpoint, you must have obtained an access token using JWT authentication. See <a href=\"/docs/monitor-api/monitor101/auth\">Authentication</a> for details.</p>\n<table>\n<tr><th>Name</th><th>Description</th></tr>\n<tr><td><code>cursor</code></td><td>A <code>string</code> query parameter that specifies the place in your monitoring data from which the request will begin gathering records. Your app can use <code>cursor</code> to keep its place while iterating through monitoring records in a way similar to how you might use a bookmark to keep your place while reading chapters of a book.\n<p>\nWhenever you successfully call the Monitor API endpoint, the response will include an <code>endCursor</code> value which you can use to create the <code>cursor</code> for your next request, enabling you to chunk your downloads as you examine large numbers of event and alert records. \n</p><p>\nCalls that do not specify a <code>cursor</code> will begin retrieving records starting seven days ago.\n</p><p>\nIf data is needed beginning at a certain point in time, <code>cursor</code> can be specified as an ISO DateTime string value (such as 2022-01-01T00:00:00Z) instead of a cursor query string. In this case, data will be retrieved beginning from that DateTime. The earliest data available in the system is from 2021-01-01.\n</p><p>\nDocusign does not return all available data in response to a single request. Your integration should iterate through the dataset using a series of API calls, with each one requesting data starting from the <code>cursor</code> value and the subsequent request starting from the <code>endCursor</code> in the response.\n</p><p>\n<strong>Note:</strong> If a request returns no data, your integration should continue iterating using <code>cursor</code> and <code>endCursor</code> until data is returned. To avoid throttling, do not make requests more frequently than once per minute.\n</p><p>\nNot required. Defaults to 0. </p>\n</td></tr>\n<tr><td><code>limit</code></td><td>An <code>Int32</code> query parameter that specifies the maximum number of records (up to 2000) to be returned in the response. \n<p>\nNot required. Defaults to 1000.</p>\n<p>\nThis parameter enforces a maximum number of records returned but does not guarantee a minimum number of records.</p>\n</td></tr>\n</table>\n\n<p>After a successful call, a set of JSON event and alert records is returned, including an <code>endCursor</code> metadata property.</p><table>\n<tr><th>Name</th><th>Description</th></tr>\n<tr><td><code>endCursor</code></td><td>A <code>string</code> value that specifies the place at which the monitoring data in the current response ended.\n<br/>\nUse the value of <code>endCursor</code> to begin your next query from this spot in your records.</td></td></tr>\n</table>\n</ds-column><ds-column col=\"6\">\n\n<p><ds-embedded-gist contentfulId=\"346j9XHtr7bUbfFF5q2Vdb\"></ds-embedded-gist></p></ds-column>"},"sys":{"type":"Entry"},"internal":{"type":"ContentfulAssemblyHtmlSection"}},{"id":"e44dd0f2-8c57-5d87-b737-1df4b74c8ccd","contentful_id":"67K2eGRCbyORrJyZXBk85d","node_locale":"en-US","heading":"Next steps","headingLevel":2,"sectionId":null,"multicolumn":false,"noBorder":false,"backgroundKind":null,"paddingTop":null,"paddingBottom":null,"html":{"html":"<ul><li>Review the event and alert objects in the <a href=/docs/monitor-api/reference>API reference</a></li><li>See <a href=/docs/monitor-api/monitor101/best-practices-handling-alerts>best practices for handling alerts</a></li><li>See <a href=/docs/monitor-api/how-to/get-monitoring-data/>how to get monitoring data</a></li></ul>"},"sys":{"type":"Entry"},"internal":{"type":"ContentfulAssemblyHtmlSection"}}],"sidebar":{"contentful_id":"57EYtLi7eYEtklU0pSMjGd","href":"/docs/monitor-api/","text":"Monitor API ","node_locale":"en-US","badgeTextOptions":null,"items":[{"text":"Overview","href":"/docs/monitor-api/","items":null},{"text":"Monitor API 101","href":"/docs/monitor-api/monitor101","items":[{"text":"Events and alerts","href":"/docs/monitor-api/monitor101/events-alerts","items":null},{"text":"Tracking data and handling alerts","href":"/docs/monitor-api/monitor101/tracking-data-handling-alerts","items":null},{"text":"Best practices for handling alerts","href":"/docs/monitor-api/monitor101/best-practices-handling-alerts","items":null},{"text":"Authentication","href":"/docs/monitor-api/monitor101/auth","items":null}]},{"text":"How-to guides","href":"/docs/monitor-api/how-to/","items":[{"text":"Code example launchers","href":"/docs/monitor-api/how-to/code-launchers/","items":null},{"text":"Enable Monitor for your organization","href":"/docs/monitor-api/how-to/enable-monitor","items":null},{"text":"Get monitoring data","href":"/docs/monitor-api/how-to/get-monitoring-data/","items":null}]},{"text":"SDKs","href":"/docs/monitor-api/sdks/","items":null},{"text":"Go-Live","href":"/docs/monitor-api/go-live","items":null},{"text":"API reference","href":"/docs/monitor-api/reference","items":null}]},"sys":{"type":"Entry"},"isMarkdownButtonField":null}},"references":{"data":{}},"badgeTextOptions":{"data":{"items":[{"version":{"data":""},"text":{"data":""}}]}}},"metadata":{"description":{"data":null},"paragraph":{},"ogTitle":{"data":"Tracking data and handling alerts"},"ogDescription":{"data":null},"ogImage":{"src":{"data":"https://images.ctfassets.net/aj9z008chlq0/3ryXhnu9Cos3q3kP986yYq/9ca7a2c7f9d33a912d253af648cde4ae/og_monitorapi.jpg"}},"keywords":{"data":[]},"locale":"en-US","slug":{"data":"/docs/monitor-api/monitor101/tracking-data-handling-alerts/"},"title":{"data":"Tracking data and handling alerts"},"typographyScheme":{"data":"non-marketing"},"backgroundKind":{"data":null},"updatedAt":{"data":"2023-07-10T14:34:10.351Z"},"createdAt":{"data":"2023-07-10T14:34:10.351Z"},"contentSource":{"data":"CM"}},"sidebarInitialState":{"Overview":{"href":"/docs/monitor-api/","hrefNew":"","icon":"","open":false,"parents":["Overview"]},"Monitor API 101":{"href":"/docs/monitor-api/monitor101","hrefNew":"","icon":"","open":false,"parents":["Monitor API 101"]},"Monitor API 101%%%%Events and alerts":{"href":"/docs/monitor-api/monitor101/events-alerts","hrefNew":"","icon":"","open":false,"parents":["Monitor API 101","Events and alerts"]},"Monitor API 101%%%%Tracking data and handling alerts":{"href":"/docs/monitor-api/monitor101/tracking-data-handling-alerts","hrefNew":"","icon":"","open":false,"parents":["Monitor API 101","Tracking data and handling alerts"]},"Monitor API 101%%%%Best practices for handling alerts":{"href":"/docs/monitor-api/monitor101/best-practices-handling-alerts","hrefNew":"","icon":"","open":false,"parents":["Monitor API 101","Best practices for handling alerts"]},"Monitor API 101%%%%Authentication":{"href":"/docs/monitor-api/monitor101/auth","hrefNew":"","icon":"","open":false,"parents":["Monitor API 101","Authentication"]},"How-to guides":{"href":"/docs/monitor-api/how-to/","hrefNew":"","icon":"","open":false,"parents":["How-to guides"]},"How-to guides%%%%Code example launchers":{"href":"/docs/monitor-api/how-to/code-launchers/","hrefNew":"","icon":"","open":false,"parents":["How-to guides","Code example launchers"]},"How-to guides%%%%Enable Monitor for your organization":{"href":"/docs/monitor-api/how-to/enable-monitor","hrefNew":"","icon":"","open":false,"parents":["How-to guides","Enable Monitor for your organization"]},"How-to guides%%%%Get monitoring data":{"href":"/docs/monitor-api/how-to/get-monitoring-data/","hrefNew":"","icon":"","open":false,"parents":["How-to guides","Get monitoring data"]},"SDKs":{"href":"/docs/monitor-api/sdks/","hrefNew":"","icon":"","open":false,"parents":["SDKs"]},"Go-Live":{"href":"/docs/monitor-api/go-live","hrefNew":"","icon":"","open":false,"parents":["Go-Live"]},"API reference":{"href":"/docs/monitor-api/reference","hrefNew":"","icon":"","open":false,"parents":["API reference"]}}}},"staticQueryHashes":["1046005517","1065676990","1243170842","1300267169","2141122023","3694524098","3727211561","4014647711","4032413523","791459392"]}