Information Technology Reference
In-Depth Information
this particular login call goes hand in hand with the logout call, which must be
executed at the end of the Api session.
ScheduleReportJobStandard
ScheduleReportJobStandard
may be one of the most exciting pull (read) calls that you
can do. A set of reporting calls is available that provides operations for getting reports
out of your Yahoo! Web Analytics Account. the report is returned in an xml format,
as you will see later in this section.
to retrieve reports, initialize your Api session and send a
ScheduleReportJobStandard
or
ScheduleReportJobBookmark
request. the response is a
reportJobId
for the scheduled report job. Get the status of the report job by sending the
getReportJob
request. the status is completed, pending, or Failed. When the status is
completed, the response also includes the download Url for the report. the returned
Url is valid for 5 minutes. if you need to obtain another Url, simply send another
getReportJob
request. make sure you keep the returned Url confidential since it
allows access to the report without the need to log in.
download the report by sending an http Get request to the download Url
using any http client library.
if you select a user-specific time zone in the user interface that is different from
the project default, the reports you access via the Api will be adjusted to the time zone
you specify.
the
ScheduleReportJobStandard
call returns the aggregated data for a project and
requires the fields listed in table A.5.
354
P
Table A.5
Fields for
ScheduleReportJobStandard
Calls
Name
Format
Description
project_id
Digits
Numeric identifier of the project. (*)
start_date
Date, iso8601
Beginning of the reporting period, such as 2006-04-01. Note
that dates must be entered in the year-month-day format. (*)
end_date
Date, iso8601
End of the reporting period, such as 2006-05-01. Note that
dates must be entered in the year-month-day format.
report_id
ReportId
Use the
getReports()
call to get the available report IDs of
the selected project.
Digits
Number of rows omitted from the beginning of the report. The
default value is 0, and the report starts with the first row. If
you are interested in looking at rows 20-30, the offset should
be 19.
Offset
Digits
Number of rows to be displayed in the report.
Limit
action_id
Digits
Numeric action identifier. This parameter is only needed for
conversion reports.
campaign_id
Digits
Numeric campaign identifier. This parameter is only needed for
generating campaign details and campaign conversion reports.
