Creates a new data extract.

Create a new Data Extract.

SecuritybearerAuth
Request
query Parameters
o
required
integer

Organization ID

Example: o=123456
Request Body schema: application/json
required
type
required
string non-empty
Default: "patch-history"

The type of Data Extract that should be created.

Enum Value Description
patch-history

Patch History data extract

api-activity

API Activity data extract

required
object
start_time
required
string <date-time> non-empty

The start date and time for the report. Validation: Previous 90 days, starting yesterday.

end_time
required
string <date-time> non-empty

The end date and time for the report. Validation: Previous 90 days, starting yesterday and must be after start_time.

Responses
200

Successful Operation

4XX

Invalid Request

default

Invalid Request

post/data-extracts
Request samples
application/json
{
  • "summary": "Data extract request example",
  • "description": "Example request for creating a patch history data extract with time parameters",
  • "value": {
    • "type": "patch-history",
    • "parameters": {
      • "start_time": "2021-05-28T13:31:57.510Z",
      • "end_time": "2021-05-30T06:42:12.117Z"
      }
    }
}
Response samples
application/json
[
  • {
    • "id": 0,
    • "organization_id": 0,
    • "user_id": 0,
    • "status": "queued",
    • "is_completed": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "download_expires_at": "2019-08-24T14:15:22Z",
    • "download_url": "http://example.com",
    • "parameters": {
      • "start_time": "2019-08-24T14:15:22Z",
      • "end_time": "2019-08-24T14:15:22Z"
      }
    }
]