Adobe  I/O Adobe Target

Audit Report

You can retrieve audit report data for off-line analysis, permanent storage, or to build a custom reporting interface.

T&T stores audit data for 4 weeks only. To preserve it, use the Campaign Audit Report API or the Admin interface to store it in a secondary location.

The activity performance REST API allows you to fetch the activity report using the parameters below. This report works for all
activity types except Automated Personalization and Optimizing.

Note: Date times should be specified in the ISO 8601 format. Do not omit the time zone related portion.

Throttling is set to the same value as for other campaign report APIs: 50 requests per minute.

No special permissions are required to access this report (read-only users have access).

Create the URL

For each operation add the parameters and values you need as a filter. For example:

https://testandtarget.omniture.com/api?client=acme&email=john@acme.com&​password=mypassword&operation=auditReport&campaignId=1234&start=2007-08-01T00:00&​end=2007-09-01T00:00&step=step1&environment=production&format=csv&version=1

Parameter

Description

client

(Required) The T&T client code.

email

(Required) The Email address associated with the T&T user performing the operation.

password

(Required) The T&T password associated with the specified email address.

operation

(Required) Identifies the type of T&T action to execute. To generate audit reports, this value is always auditReport.

campaignId

(Required) The ID of the campaign you want to query. To identify the Campaign List ID, Use the Campaign List API or look at the campaignDescriptionId parameter in the URL when viewing a campaign in the T&T Tool.

start

(Required) The report start date and time. Specify the date using the following format: YYYY-MM-DDTHH:mm. The performance report uses the time zone setting specified in the Web browser.

en

(Required) The report end date and time. Specify the date using the following format: YYYY-MM-DDTHH:mm. The performance report uses the time zone setting specified in the Web browser.

step

(Optional) The URL-encoded success metric name (formerly called a step). By default, the step value is last step.

environment

(Required) A URL-encoded host group name, as defined in the T&T Tool. By default, the environment value is Production.

format

(Optional) The report output format. Currently, the only supported value for this parameter is csv (comma-separated value).

version

Specify which version of the API you want to use. Set this to version=1 unless there is a different version described in the documentation.

Parameters and values are case sensitive.


Inspect the Query Response

Target generates the audit report in CSV format, which you can import into any spreadsheet program, such as Microsoft* Excel*. For example:

"Campaign: landing campaign RFM"
"Downloaded at: 2007-08-24. Time zone: EST5EDT"
"Step: Conversion"
"Campaign Id","Recipe","Order Date","Order Time","Order Id","Amount","Order Flag","Product Ids""worst",""
42,81,"2007-08-20","17:25:29","1187645128929",$429.00,"---","9"
42,81,"2007-08-20","17:25:36","1187645135874",$319.00,"---","7"
42,81,"2007-08-20","17:25:43","1187645142834",$325.00,"---","5""best",""
42,82,"2007-08-20","16:56:11","1187643370833",$325.00,"---","5"
42,82,"2007-08-20","16:56:16","1187643376266",$479.00,"---","3"
42,82,"2007-08-20","16:58:15","1187643495634",$99.95,"---","42"

Parse the Query Response

Optionally, you can use a scripting language, such as Perl, Python, and Ruby, to programmatically manipulate the audit report contents to create custom reports.

Parameters

Name Description Allowed Values Default Value
environmentId The TnT environment Id TnT environment Id Id of the client's "Default for Reporting" environment
conversionMetricLocalId Local ID(s) of the conversion metrics. Can use more than one metric as conversion, e.g. to use metrics with local IDs 11 and 12 as conversion metrics, pass conversionMetricLocalId=11&conversionMetricLocalId=22. Valid metric local ID 32767
metricLocalId Local IDs of metrics to be included in report. If not specified, only the campaign totals (summary) will be generated. Can specify multiple values as metricLocalId=11&metricLocalId=22. Can use the hardcoded local IDs of 0, 2 and 32767. Valid metric local IDs If not specified, only campaign totals will be generated, without metric level data.
reportingSegmentLocalId Local ID(s) of the reporting segments for which reports should be generated. If no value is specified, then only the campaign totals (without any reporting segment) report will be generated. If multiple reporting segments are specified, then, besides the campaign total report, the reports for the indicated reporting segments will be generated. To include all reporting segments enumerate them all as reportingSegmentLocalId=11&reportingSegmentLocalId=22&... Valid reporting segment local ID If no value is specified then only campaign totals report will be generated without segment reports
reportInterval Report period. If not specified, then life of campaign will be used. Interval start date will be floor rounded to nearest hour and interval end date bill be ceiling rounded to next hour. Time interval in ISO format, e.g. 2007-03-01T21:00:00-07:00/2008-05-11T21:00:00-07:00. Life of campaign.
daysOfWeek List of days of the week to include. All days will be included if not specified. To specify more than one value, e.g. Saturday and Sunday, use: dayOfWeek=6&dayOfWeek=7 1-7, with 1 corresponding to Monday, 2 - Tuesday etc All days of the week
resolution Resolution to group data by. If it's not specified, then only totals over the entire report period will be shown.

hour | day | week | month

Maximum number of generated data points for the specified resolution and report period should not exceed 100

If not specified, then only totals for the entire report period will be generated

All deleted experiences will be included in the report, even the ones that have no data. Deleted success metrics and reporting segments will not be shown.

Data for all counting methods will be included in the report, as well as corresponding lifts and confidence (with confidence intervals). In order to determine a winning experience, iterate through the list of reports for each experience and find the one with maximal lift.

Response JSON Structure

Copy
{ "reportParameters": { "campaignId": 7, "thirdPartyId~": "campaign's third party ID", "environmentId": 8, "reportInterval": "2015-01-12T03:00:00.000-05:00/2015-05-08T04:22:24.755-04:00", "daysOfWeek~": [ 1, 2, 3, 4, 5 ], "resolution~": "week", "conversionMetricLocalIds": [32767], "metricLocalIds": [ 2, 0 ], "reportingSegmentLocalIds": [ 0, 1 ] }, "campaign": { "id": 7, "type": "ab", "name": "Test Campaign", "state": "approved", "priority": 0, "createdAt": "2015-01-12T00:18:05.000-08:00", "createdBy": "demo@fortpoint.com", "modifiedAt": "2015-02-20T23:06:27.000-08:00", "modifiedBy": "demo@fortpoint.com", "marketingCloudMetadata": { "sourceProductName": "Adobe Target Advanced", "editURL": "https://admin-guzun.dev.testandtarget.omniture.com/admin/campaign/campaign_edit_forward.jsp?campaignId=7", "remoteModifiedBy": "Mr Demo" }, "campaignLink": { "url": "http://admin/admin/rest/v1/campaigns/ab/21", "rel": "/v1/campaigns/ab/21" }, "experiences": [ { "name": "Experience A", "experienceLocalId": 0 } ], "metrics": [ { "name": "Entry", "metricLocalId": 0 } ], "reportingSegments~": [ { "name": "segment1", "reportingSegmentLocalId": 0 } ] }, "report": { "statistics": { "totals": { "visitor": { "totals": { "entries": 18044, "conversions": 7124 }, "intervals": [ { "interval": "2015-02-16T00:00:00.000-08:00/2015-02-23T00:00:00.000-08:00", "totals": { // Same structure as visitor totals } } ] }, "visit": { // Same structure as visitor }, "impression": { // Same structure as visitor }, "landing": { // Same structure as visitor }, "timeToConversion": { "totals": { "total": 8, // seconds "sumOfSquares": 24 // seconds }, "intervals": [ { "interval": "2015-02-16T00:00:00.000-08:00/2015-02-23T00:00:00.000-08:00", "totals": { "total": 8, // seconds "sumOfSquares": 24 // seconds } } ] }, "orders": { "totals": { "count": 7143, "sales": 36330198, "sumOfSquares": 244893691592, "outlierIncludedCount": 7143, "outlierIncludedSales": 36330198, "outlierIncludedSumOfSquares": 244893691592 }, "intervals": [ { "interval": "2015-02-16T00:00:00.000-08:00/2015-02-23T00:00:00.000-08:00", "totals": { // Same structure as order totals } } ] }, "metrics": [ { "metricLocalId": 0, "totals": { "visitor": 18044, "visit": 18044, "impression": 18044 }, "intervals": [ { "interval": "2015-02-16T00:00:00.000-08:00/2015-02-23T00:00:00.000-08:00", "totals": { "visitor": 18044, "visit": 18044, "impression": 18044 } } ] } ] }, "experiences": [ { "experienceLocalId": 0, "totals": { // same structure as statistics totals }, "reportingSegments": [ { "reportingSegmentLocalId": 0, "statistics": { // same structure as report statistics } } ] } ] } } }