Creates a new Data Extract.

Create a new Data Extract.

SecuritybearerAuth
Request
query Parameters
o
required
integer

Organization ID

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.

example
patch-history
Responses
200

Successful Operation

400

Invalid Request

401

Access token is missing or invalid

403

You do not have permission to perform this action.

404

Entity not found

429

Too many requests

503

Service Unavailable

default

Invalid Request

post/data-extracts
Request samples
application/json
{
  • "type": "patch-history",
  • "parameters": {
    • "start_time": "2019-08-24T14:15:22Z",
    • "end_time": "2019-08-24T14:15:22Z"
    },
  • "example": null
}
Response samples
application/json
[
  • {
    • "id": 75,
    • "organization_id": 1,
    • "user_id": 1,
    • "status": "queued",
    • "is_completed": false,
    • "created_at": "2021-03-30T16:03:04.608690+0000",
    • "download_expires_at": null,
    • "download_url": null,
    • "parameters": {
      • "start_time": "2021-02-03T00:00:00+0000",
      • "end_time": "2021-03-18T16:19:00+0000"
      }
    }
]