/auditlogs/exports/{jobid}

Retrieve information about a specific event log export job.

Resource URL

/v2/applications/{communityApiKeyName}/auditlogs/exports/{jobid}

Note: You must use a regional endpoint when making requests to this endpoint. For details about the available region endpoints, see Shared responsibility.

Available methods

Method	Description
GET	Returns a single instance of an event log export job.

Available Fields

Field	Description
id	The unique identifier for the export job.
status	The string name for the job status. Possible values include: Succeeded - The export job succeeded and the event log file is ready for download. Failed - The export job failed. Queued - The export job has not started yet. Executing - The export job is in progress.
errormessage	Null, unless the status is "Failed". For failed jobs the error message returned by the endpoint is listed.
data	The URL to use to retrieve the temporary link used to download the export file.

Example GET Response

{
    "id": "a11e0e22-a3e6-dd9c-35d5-4bbe61fefbe9",
    "status": "<Succeeded|Failed|Queued|Executing>",
    "errormessage": "<null|error message for failed job>",
    "data": "<URL of file download link>"
}

Parent topic: Event Log endpoints