REST API for Oracle Eloqua Marketing Cloud Service

Initiate an audit log export

post

/api/rest/2.0/data/auditLog/reportExport

Creates a request for an audit log export that matches the criteria specified by the request body.

Request

Supported Media Types

application/json

Audit log export request

Root Schema : AuditLogReportRequest

Type: object

Title: AuditLogReportRequest

Show Source

actionName: string

The event action to filter for the audit log. Possible values include: all, create, modify, delete, archive and unarchive. For campaigns, possible values also include: activated, deactivated, pause, and scheduleForActivation. If not specified, defaults to all.
assetTypes: string

The asset type for the Audit log. Required if auditReportType is set to assets. Possible values include: forms, programs, campaigns, emails, and landingPages. Specify multiple asset types by comma separating values.
auditReportType: string

Specifies the Audit Report Type to generate. Possible values include: assets (asset history), securityGroup (security group history), userProfile (user profile history), userLogin (user login history), dataExport (export history), and dataUpload (upload history).
endDate: string

The end date and time (10 digit integer Unix time). This property is required.
fileFormat: string

File format to be exported. Possible values include: delimitedFile or Excel2007.
notificationEmail: string

Email address for export notification. This property is required.
startDate: string

The start date and time (10 digit integer Unix time). This property is required.
status: string

For dataUpload and dataExport audit reports, you can filter on the status. Possible values include: completed, in progress, queued, waiting, failed, and inactive.
type: string

This property is not used.
userName: string

The user name to filter on.

{
    "title":"AuditLogReportRequest",
    "properties":{
        "type":{
            "type":"string",
            "description":"This property is not used."
        },
        "auditReportType":{
            "type":"string",
            "description":"Specifies the Audit Report Type to generate. Possible values include: <code>assets</code> (asset history), <code>securityGroup</code> (security group history), <code>userProfile</code> (user profile history), <code>userLogin</code> (user login history), <code>dataExport</code> (export history), and <code>dataUpload</code> (upload history)."
        },
        "startDate":{
            "type":"string",
            "description":"The start date and time (10 digit integer Unix time). This property is required."
        },
        "endDate":{
            "type":"string",
            "description":"The end date and time (10 digit integer Unix time). This property is required."
        },
        "notificationEmail":{
            "type":"string",
            "description":"Email address for export notification. This property is required."
        },
        "fileFormat":{
            "type":"string",
            "description":"File format to be exported. Possible values include: <code>delimitedFile</code> or <code>Excel2007</code>."
        },
        "assetTypes":{
            "type":"string",
            "description":"The asset type for the Audit log. Required if <code>auditReportType</code> is set to <code>assets</code>. Possible values include: <code>forms</code>, <code>programs</code>, <code>campaigns</code>, <code>emails</code>, and <code>landingPages</code>. Specify multiple asset types by comma separating values."
        },
        "actionName":{
            "type":"string",
            "description":"The event action to filter for the audit log. Possible values include: <code>all</code>, <code>create</code>, <code>modify</code>, <code>delete</code>, <code>archive</code> and <code>unarchive</code>. For campaigns, possible values also include: <code>activated</code>, <code>deactivated</code>, <code>pause</code>, and <code>scheduleForActivation</code>. If not specified, defaults to <code>all</code>."
        },
        "status":{
            "type":"string",
            "description":"For <code>dataUpload</code> and <code>dataExport</code> audit reports, you can filter on the status. Possible values include: <code>completed</code>, <code>in progress</code>, <code>queued</code>, <code>waiting</code>, <code>failed</code>, and <code>inactive</code>."
        },
        "userName":{
            "type":"string",
            "description":"The user name to filter on."
        }
    }
}

Response

Supported Media Types

application/json

201 Response

Request for the audit log has been registered. An email containing a link to the exported data will be sent to the email address for export notification

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.

Examples

The following examples demonstrate how to create a request for an audit log using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Initiate an audit log export for campaign assets for all actions:


POST /api/REST/2.0/data/auditlog/reportExport
Content-Type: application/json

Request body:


{
  "auditReportType": "assets",
  "startDate": "1546837200",
  "endDate": "1547528400",
  "notificationEmail": "API.User@oracle.com",
  "fileFormat": "delimitedFile",
  "assetTypes": "campaigns",
  "actionName": "all"
}

Response:


201 Created

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.


curl --user "APITest\API.User" --header "Content-Type: application/json" --request POST --data '{"auditReportType":"assets","startDate":"1483729793","endDate":"1546780193","notificationEmail":"API.User@oracle.com","fileFormat":"delimitedFile","assetTypes":"campaigns","actionName":"all"}' https://secure.p03.eloqua.com/api/rest/2.0/data/auditlog/reportExport

HTTP Request Example

Initiate an audit log export for forms and landing pages for all actions:


POST /api/REST/2.0/data/auditlog/reportExport
Content-Type: application/json

Request body:


{
  "auditReportType": "assets",
  "startDate": "1546837200",
  "endDate": "1547528400",
  "notificationEmail": "API.User@oracle.com",
  "fileFormat": "Excel2007",
  "assetTypes": "forms, landingPages",
  "actionName": "all"
}

Response:


201 Created

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.


curl --user "APITest\API.User" --header "Content-Type: application/json" --request POST --data '{"auditReportType":"assets","startDate":"1546837200","endDate":"1547528400","notificationEmail":"API.User@oracle.com","fileFormat":"Excel2007","assetTypes":"forms, landingPages","actionName":"all"}' https://secure.p03.eloqua.com/api/rest/2.0/data/auditlog/reportExport