Appointment Results

Appointment Results Documentation

Appointment Result [LIST]

Appointment Result [LIST]

Request

Endpoint

GET /api/v2/reports/appointment_results
Content-Type: application/vnd.api+json

Body

Parameters

Filters

account_list_id

Type string

Description The account list to run the report on.

Required No

end_date

Type string

Description The date in which you would like the report to end on. This will be shifted to the end of the final period. Default: today

Required No

range

Type string

Description A string defining the number of periods and how long they should be with an indictor: (d)ay, (w)eek, (m)onth, (y)ear. Examples: 30d, 2w, 12m, 1y. Default: 4m

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "2021-11-21",
      "type": "reports_appointment_results_periods",
      "attributes": {
        "appointments_scheduled": 0,
        "created_at": "2021-11-23T14:38:25Z",
        "end_date": "2021-11-27",
        "group_appointments": 0,
        "individual_appointments": 0,
        "monthly_decrease": 0,
        "monthly_increase": 0,
        "new_monthly_partners": 0,
        "new_special_pledges": 0,
        "pledge_increase": "0.0",
        "special_gifts": 0,
        "start_date": "2021-11-21",
        "updated_at": null,
        "updated_in_db_at": null,
        "weekly_individual_appointment_goal": 10
      },
      "relationships": {
        "pledge_increase_contacts": {
          "data": [

          ]
        },
        "new_pledges": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "2021-11-14",
      "type": "reports_appointment_results_periods",
      "attributes": {
        "appointments_scheduled": 0,
        "created_at": "2021-11-23T14:38:25Z",
        "end_date": "2021-11-20",
        "group_appointments": 0,
        "individual_appointments": 0,
        "monthly_decrease": 0,
        "monthly_increase": 0,
        "new_monthly_partners": 0,
        "new_special_pledges": 0,
        "pledge_increase": "0.0",
        "special_gifts": 0,
        "start_date": "2021-11-14",
        "updated_at": null,
        "updated_in_db_at": null,
        "weekly_individual_appointment_goal": 10
      },
      "relationships": {
        "pledge_increase_contacts": {
          "data": [

          ]
        },
        "new_pledges": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "2021-11-07",
      "type": "reports_appointment_results_periods",
      "attributes": {
        "appointments_scheduled": 0,
        "created_at": "2021-11-23T14:38:25Z",
        "end_date": "2021-11-13",
        "group_appointments": 0,
        "individual_appointments": 0,
        "monthly_decrease": 0,
        "monthly_increase": 0,
        "new_monthly_partners": 0,
        "new_special_pledges": 0,
        "pledge_increase": "0.0",
        "special_gifts": 0,
        "start_date": "2021-11-07",
        "updated_at": null,
        "updated_in_db_at": null,
        "weekly_individual_appointment_goal": 10
      },
      "relationships": {
        "pledge_increase_contacts": {
          "data": [

          ]
        },
        "new_pledges": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "2021-10-31",
      "type": "reports_appointment_results_periods",
      "attributes": {
        "appointments_scheduled": 0,
        "created_at": "2021-11-23T14:38:25Z",
        "end_date": "2021-11-06",
        "group_appointments": 0,
        "individual_appointments": 0,
        "monthly_decrease": 0,
        "monthly_increase": 0,
        "new_monthly_partners": 0,
        "new_special_pledges": 0,
        "pledge_increase": "0.0",
        "special_gifts": 0,
        "start_date": "2021-10-31",
        "updated_at": null,
        "updated_in_db_at": null,
        "weekly_individual_appointment_goal": 10
      },
      "relationships": {
        "pledge_increase_contacts": {
          "data": [

          ]
        },
        "new_pledges": {
          "data": [

          ]
        }
      }
    }
  ],
  "meta": {
    "sort": null,
    "filter": {
    },
    "averages": {
      "average_appointments_scheduled": 0,
      "average_individual_appointments": 0,
      "average_group_appointments": 0,
      "average_new_monthly_partners": 0,
      "average_new_special_pledges": 0,
      "average_special_gifts": 0,
      "average_monthly_increase": 0,
      "average_pledge_increase": 0
    }
  }
}

Fields

data

Type [Appointment Results Period]

Description An array of Appointment Results Periods