Marketing API Version

ReportSchedules

Provides operations to create, read, update and delete ReportSchedules.

Read ReportSchedule

Permissions

A user access token with Atlas API capability is required to request report schedule details.

Fields

Reading this endpoint returns a single or an array of ReportSchedule objects with the same fields as the node.

Read Report Schedule

You can get details of the schedules of a report by making an HTTP GET request.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<REPORT_ID>/report_schedules

Response:

{
  "data": [
    {
      "created_date": "2014-03-14T13:39:20-07:00",
      "date_range": {
        "end_date": "2014-03-25T17:05:36-04:00",
        "begin_date": "2014-03-25T11:32:16-04:00",
        "time_zone": "America/New_York"
      }
      "id": "11002200631900",
      "is_active": true, 
      "last_modified_date": "2014-03-24T17:36:22-07:00",
      "minute_of_day": "120",
      "recurrence_type": "weekly",
      "recurrence_value": "2",
      "report_id": "11002200631500",
      "version": "4"
    }
  ]
}

Curl Example:

A curl example to get report schedules:

curl -G \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<API_VERSION>/<REPORT_ID>/report_schedules

Create Atlas ReportSchedules

Permissions

A user access token with Atlas API capability is required to create or update reportschedule details.

Fields

Publishing this endpoint returns a single or an array of ReportSchedule objects.

Create ReportSchedule

You can create reportschedule by making an HTTP POST request. It will update the reportschedule if it already exists.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<REPORT_ID>/report_schedules?report_schedules=[{ "version": "2", "report_id": "11002200631500", "minute_of_day": "480", "recurrence_type": "once", "recurrence_value": "0", "is_active": true, "date_range": { "end_date": "2014-10-17T00:00:00-04:00",  "begin_date": "2014-10-17T00:00:00-04:00", "time_zone": "America/New_York" } }]

Response:

{
  "data": [
    {
      "id": "11002200631900", 
      "success": true
    }
  ]
}

Curl Example

A curl example to create reportschedule:

curl \
  -F 'report_schedules=[{ "version": "2", "report_id": "11002201242902", "minute_of_day": "480", "recurrence_type": "once", "recurrence_value": "0", "is_active": true, "date_range": { "end_date": "2014-10-17T00:00:00-04:00",  "begin_date": "2014-10-17T00:00:00-04:00", "time_zone": "America/New_York" } }]' \
  -F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<API_VERSION>/<REPORT_ID>/report_schedules

Delete ReportSchedule

Permissions

A user access token with Atlas API capability is required to delete report schedule.

Delete ReportSchedule

You can delete report schedules by making an HTTP DELETE request.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<REPORT_SCHEDULE_ID>

Response:

{
  "data": [
    {
      "report_schedule": {
        "id": "11002201248089", 
        "created_by": "1444052205", 
        "created_date": "2014-09-08T12:43:03-07:00", 
        "last_modified_by": "1444052205", 
        "last_modified_date": "2014-09-08T13:01:22-07:00", 
        "is_deleted": true, 
        "version": "2", 
        "report_id": "11002201242902", 
        "minute_of_day": "480", 
        "recurrence_type": "once", 
        "recurrence_value": "0", 
        "is_active": true, 
        "date_range": {
          "end_date": "2014-10-25T00:00:00-04:00", 
          "begin_date": "2014-10-25T00:00:00-04:00", 
          "time_zone": "America/New_York"
        }
      }
    }
  ]
}

Curl Example:

A curl example to delete report schedule:

curl -XDELETE \
  -F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<API_VERSION>/<REPORT_SCHEDULE_ID>