-
Notifications
You must be signed in to change notification settings - Fork 18
/
Copy pathmonitor.rest.swagger-v2.0.json
176 lines (176 loc) · 6.82 KB
/
monitor.rest.swagger-v2.0.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
{
"swagger": "2.0",
"info": {
"version": "v2.0",
"title": "Monitor API",
"description": "An API for an integrator to access the features of DocuSign Monitor",
"termsOfService": "https://www.docusign.com/company/terms-and-conditions/web",
"contact": {
"name": "DocuSign Developer Center",
"url": "https://developers.docusign.com",
"email": "devcenter@docusign.com"
}
},
"host": "lens-d.docusign.net",
"basePath": "",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"externalDocs": {
"description": "",
"url": ""
},
"license": {
"name": "Terms and Conditions",
"url": "https://www.docusign.com/company/terms-and-conditions/web"
},
"paths": {
"/api/v{version}/datasets/{dataSetName}/stream": {
"get": {
"tags": [
"DataSet"
],
"summary": "Gets customer event data for an organization.",
"description": "Gets customer event data for the organization that owns the integration key.\n\nThe results for this endpoint are paginated by event timestamp. Use the `cursor` parameter to specify where the query begins in the dataset. Use the `limit` parameter to set the number of records returned.\n",
"operationId": "Api_Version_DatasetsByDataSetNameStreamGet",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "dataSetName",
"in": "path",
"description": "Must be `monitor`.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Must be `2`.\n",
"required": true,
"type": "string",
"default": "2.0"
},
{
"name": "cursor",
"in": "query",
"description": "Specifies a pointer into the dataset where your query will begin. You can either provide an ISO DateTime or a string cursor (from the `endCursor` value in the response). If no value is provided, the query begins from seven days ago.\n\nFor example, to fetch event data beginning from January 1, 2022, set this value to `2022-01-01T00:00:00Z`. The response will include data about events starting from that date in chronological order. The response also includes an `endCursor` property. To fetch the next page of event data, call this endpoint again with `cursor` set to the previous `endCursor` value.\n",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of records to return. The default value is 1000.",
"required": false,
"type": "integer",
"format": "int32",
"default": 1000
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CursoredResult"
}
}
},
"security": [
{
"accessCode": [
"impersonation"
]
}
],
"x-ds-methodname": "getStream",
"x-ds-method": "getStream",
"x-ds-service": "DataSet",
"x-ds-in-sdk": true
}
}
},
"definitions": {
"CursoredResult": {
"type": "object",
"properties": {
"endCursor": {
"type": "string",
"description": ""
},
"data": {
"uniqueItems": false,
"type": "array",
"items": {
"type": "object"
},
"description": ""
}
},
"x-ds-definition-name": "CursoredResult",
"description": "",
"x-ms-summary": ""
},
"DataSet": {
"type": "object",
"properties": {
"endCursor": {
"type": "string",
"description": ""
},
"data": {
"uniqueItems": false,
"type": "array",
"items": {
"type": "object"
},
"description": ""
}
},
"x-ds-definition-name": "CursoredResult",
"description": "Methods to fetch organization event data.",
"x-ms-summary": "Methods to fetch organization event data.",
"x-ds-category": "Monitor",
"x-ds-order": "100"
}
},
"securityDefinitions": {
"Bearer": {
"name": "Authorization",
"in": "header",
"type": "apiKey",
"description": "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\""
}
},
"security": [
{
"Bearer": []
}
],
"x-ds-categories": [
{
"name": "Monitor",
"summary": "The DocuSign Monitor API receives a data feed containing security events for your DocuSign account. This data goes directly to whichever application or website you choose to integrate with DocuSign's eSignature REST API.",
"description": "Each time an event occurs, DocuSign Monitor returns JSON Data Types from a download endpoint. The endpoints include the Monitor UI, SIEMs such as Splunk, and other Customer API endpoints.\n\n**Note:** Your accounts must exist inside an organization to access this data.\n"
}
],
"x-ds-devdocs": {
"stamp": "ca00a16 2022-10-04 12:15:28-0400"
},
"tags": [
{
"name": "DataSet",
"description": "The DataSet resource provides methods that allow you to fetch organization event data. The `dataSet` path parameter must be set to `monitor`."
}
]
}