Information Technology Reference
In-Depth Information
P
Table A.5
Fields for
ScheduleReportJobStandard
Calls
(Continued)
Name
Format
Description
scenario_id
Digits
Use the
getScenarios()
call to get the available scenario
IDs of the selected project.
session_id
Maximum of
10 characters
Session identifier. This parameter is only needed for
the session path report.
sort
Digits
Specifies the sort value of the columns: 0 means the first
column, 1 the second column, and so on. Note that the sorting
order always starts with the sort values of the left-hand labels.
sort_direction
Maximum of
4 characters
Sorts the column specified in the sort field. Possible values are
asc
(for ascending) and
desc
(for descending).
Boolean
Indicates whether report help should be included in the
response.
show_help
Boolean
Indicates whether report description should be included in the
response.
show_description
Filters
Structure
For details, see Table A.7.
355
table A.6 lists the returned output fields after a
ScheduleReportJobStandard
request has been made.
P
Table A.6
Return Fields for
ScheduleReportJobStandard
Calls
Name
Format
Description
ReportJobId
Long
The ID of the report job to be used in subsequent
getReportJob
calls.
When using filters, you perform filtering much as you would in the interface.
the
ScheduleReportJobStandard
call returns the exceptions based on the filter fault
codes. the filter structure is described in table A.7.
P
Table A.7
Fields for Filters Structure
Name
Format
Description
String
Indicates the ID type of the filter.
Type
Operator
String
Indicates the operator to be used for a filter. It can be a String or
a Number operator. String operators include Equals, NotEquals,
BeginsWith, NotBeginsWith, EndsWith, NotEndsWith, Contains,
NotContains, Empty, NotEmpty, and Regexp. Number operators
include Equals, NotEquals, Greater, GreaterOrEquals, Less, and
LessOrEquals.
Value
String
Indicates the value of the filter (e.g., when filtering by the
Browser report, the value can be Firefox).
CaseSensitive
Boolean
Indicates whether the value is case-sensitive.
Scope
String
Indicates the scope of the filter. Possible values are
Session
,
Action
, and
Page View
.