tns:reportDefinition
A structure that contains information for creating a specific report.| Element | Type | Description |
|---|---|---|
| reportSuiteID | xsd:string | The SiteCatalyst report suite you want to use to generate the report. For example: reportSuiteID = "corp1" |
| date | xsd:string | The date for which you want to run the report. When using date, do not use dateFrom and dateTo. The date format is YYYY-MM-DD (4 digit year, 2 digit month, and 2 digit day), but the month and day designators are optional. For example: date = "2009-01" |
| dateFrom | xsd:string | The starting date used to run the report for when using a data range. When using dateFrom, do not use date. The date format is YYYY-MM-DD (4 digit year, 2 digit month, and 2 digit day), but the month and day designators are optional. For example: date = "2009-01-15" |
| dateTo | xsd:string | The ending date used to run the report for when using a data range. When using dateTo, do not use date. The date format is YYYY-MM-DD (4 digit year, 2 digit month, and 2 digit day), but the month and day designators are optional. For example: date = "2010-01-15" |
| dateGranularity | tns:reportDefinitionDateGranularity | The time units used to display data in a report that organizes the data by date, such as an Overtime report. For example: dateGranularity = "day" |
| metrics | tns:reportDefinitionMetricList | A list of the events to include in the report. A report must specify at least one metric (Ranked/Overtime reports support one or more metrics. Trended reports support only one metric.) For example:metrics = [ {id = "pageViews"},{id = "visits"} ] |
| elements | tns:reportDefinitionElementList | Not supported by Overtime reports. A list of elements that breaks down (organizes) the metrics data in the report. For example, you can generate a report that breaks down page views (metric) by browser (element). For example: elements = [ {id = "trackingCode", classification = "campaigns", top = 2, startingWith = 10} ] |
| locale | tns:reportDefinitionLocale | The geographic locale where you want to run the report. |
| sortBy | xsd:string | Not currently implemented. |
Comments (0)
Must be logged in to comment. Login or register now to comment!