Programs

List program daily task reports

Changed on

Returns counts of nightly tasks the job has already finished for the program, over the given date range and resolution. Each row covers one period with finished tasks. Periods with no finished tasks are omitted.

Does not list what is scheduled. Pending points, activation dates, and expiration dates that are still waiting do not appear. A count is stored on the date the job finishes the task. Tasks finished before this report existed are not included.

The date range is limited per resolution:

  • 90 days for day,
  • 12 weeks for week,
  • 12 months for month,
  • 4 quarters for quarter,
  • start_date must be before end_date,
  • start_date and end_date are inclusive.

Returns 400 when query validation fails. Returns 404 when the program does not exist.

A successful call records no activity.

get/v2/loyalties/programs/{programId}/reports/daily-tasks/daily

Request

Query parameters

start_datestring date required

Sets the inclusive start of the report date range. Format YYYY-MM-DD.

end_datestring date required

Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date.

resolution'day' | 'week' | 'month' | 'quarter' required

Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters.

Response

Program daily tasks report.

object'report' required

Object type marker. Always report.

Changes