Jump to: navigation, search

Reporting methods

createReportRequest(ReportRequest reportRequest, BaseEntity baseEntity)

Schedules a report request.

Input

  • reportRequest: Items required to create a valid report request of the type specified.
  • baseEntity : internalId or externalId, and type where applicable.

Response

Job (D)

Availability

Engage 7.3.3

Errors returned

  • ARG_INVALID_TYPE – Argument is of invalid type '%s'
  • ARG_NULL – Invalid Data, argument '%s' must be non-null
  • ATTRIBUTE_NULL – Attribute supplied is null
  • ATTRIBUTE_INVALID – Attribute is not valid
  • ATTRIBUTE_INVALID_CHAR – Invalid report time frame, delivery address or compression mode
  • ATTRIBUTE_INVALID_DATA – Invalid Data '%s
  • ATTRIBUTE_INVALID_FORMAT – Email address is not valid
  • OBJECT_NOT_EXISTS – Unable to find account associated with Org
  • SYSTEM_LIMIT_EXCEEDED – maximum number of active ReportRequests exceeded

Notes

  • The supplied Org must be either a valid Account or Enterprise.
  • The maximum number of active ReportRequests is 50.

listReportRequests(Org org)

Retrieves a list of scheduled reports.

Input

org : internalId or (externalId, parent, type)

Response

ReportRequest[] (D)

Availability

Future

Errors returned

  • ARG_INVALID_TYPE – Argument is of invalid type '%s'
  • ARG_NULL – Invalid Data, argument '%s' must be non-null
  • OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
  • RESULT_TOO_LARGE – Result returned would be too large

Notes

  • The supplied Org must be either a valid Account or Enterprise.
  • The maximum number of items returned using this method is 1,000.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on 6 September 2016, at 11:25.