Show a new data extract job.

Retrieves a specific Data Extract job.

SecuritybearerAuth
Request
path Parameters
id
required
integer <int64>

The ID of the Data Extract you want to view.

Example: 654321
query Parameters
o
required
integer <int64>

The ID of the target organization

Example: o=123456
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

get/data-extracts/{id}
Request samples
$apiKey = 'your_automox_api_key'
$headers = @{ "Authorization" = "Bearer $apiKey" }
$url = "https://console.automox.com/api/data-extracts/000?o=12345"
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers -ContentType "application/json").Content
Response samples
application/json
{
  • "summary": "Data extract example",
  • "description": "Example of a data extract job showing status, parameters, and download information",
  • "value": [
    • {
      • "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"
        }
      }
    ]
}