Filtered Reports
AddFilteredReport [finished]
Overlays:
Activation:
AddFilteredReport.php ? sessionID = ... & campaignID = ... & lowerTimeUnit = ... & upperTimeUnit = ... & name = ...
[ & email = ... ]
Description:
Adds new filtered report (user defined filter for campaign time
used to compute statistics) and assigns ID to it. No more than 1000 filtered reports can be added in hour.
Parameters:
- sessionID: string(16)
- campaignID: uint
- lowerTimeUnit: timeunit - filter start date
- upperTimeUnit: timeunit - filter end date
- name: string(63)
- email: string(255) - used to send notification, that statistics have been calculated
Results:
<AddFilteredReport>
<status>OK</status>
<filteredReportID>123</filteredReportID> : uint
</AddFilteredReport >
Throw Errors:
DeleteFilteredReport [finished]
Overlays:
Activation:
DeleteFilteredReport.php ? sessionID = ... & filteredReportID = ...
Description:
Deletes previously created filtered report.
Parameters:
- sessionID: string(16)
- filteredReportID: uint
Results:
<DeleteFilteredReport>
<status>OK</status>
</DeleteFilteredReport>
Throw Errors:
GetFilteredReportsList [finished]
Overlays:
Activation:
GetFilteredReportsList.php ? sessionID = ... & campaignIDs = ...
[ & humanDates = ... ]
Description:
Returns a list of ordered filtered reports. See AddFilteredReport.
Parameters:
- sessionID: string(16)
- campaignIDs: uint list
- humanDates: enum('Y','N') - default 'N' : when this option is enabled, start and end date are printed in human readable format, otherwise in UNIX Timestamp-like format. To convert timestamp-like format to human readable, one needs to interpret the timestamp in GMT time zone.
Results:
<GetFilteredReportsList>
<status>OK</status>
<filteredReportsNumber>1234</filteredReportsNumber> : uint - records number
<filteredReports>
<filteredReport>
<filteredReportID>1</filteredReportID> : uint
<name>rep</name> : string(63)
<email>abc@de.ef</email> : string(255)
<campaignID>123</campaignID> : uint
<campaignName>some campaign</campaignName> : string(255)
<isReady>Y</isReady> : enum('Y', 'N') - are statistics already computed
<lowerTimeUnit>1242123024</lowerTimeUnit> : date/timestamp-like - filter start date
<upperTimeUnit>1242123024</upperTimeUnit> : date/timestamp-like - filter end date
</filteredReport>
</filteredReports>
</GetFilteredReportsList>