Monthly Giving Graph

Monthly Giving Graph Documentation

Monthly Giving Graph [GET]

Monthly Giving Graph [GET]

Request

Endpoint

GET /api/v2/reports/monthly_giving_graph
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

designation_account_id

Type ID string

Description Filter by designation account ID; Accepts comma separated ids

Required No

display_currency

Type string

Description Currency to render the report in

Required No

donation_date

Type date

Description Filter donations including only those with donation_date within the provided date range

Required No

donor_account_id

Type ID string

Description Filter by donor account ID; Accepts comma separated ids

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "reports::monthlygivinggraph",
    "type": "reports_monthly_giving_graphs",
    "attributes": {
      "created_at": "2022-01-12T17:18:24Z",
      "display_currency": "USD",
      "display_currency_symbol": "$",
      "monthly_average": 0,
      "monthly_goal": null,
      "months_to_dates": [
        "2021-02-01",
        "2021-03-01",
        "2021-04-01",
        "2021-05-01",
        "2021-06-01",
        "2021-07-01",
        "2021-08-01",
        "2021-09-01",
        "2021-10-01",
        "2021-11-01",
        "2021-12-01",
        "2022-01-01"
      ],
      "multi_currency": false,
      "pledges": 0,
      "salary_currency": "USD",
      "salary_currency_symbol": "$",
      "totals": [

      ],
      "updated_at": null,
      "updated_in_db_at": null
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "65eeea3d-f249-4b21-96bf-d0d654aa3c41",
          "type": "account_lists"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

display_currency

Type string

Description Display Currency or Default currency of account_list

display_currency_symbol

Type string

Description Display Currency symbol or Default currency symbol of account_list

monthly_average

Type number

Description Average monthly total conversion

monthly_goal

Type number

Description The Account List's monthly goal

months_to_dates

Type ["string"]

Description The first day of each month represented

multi_currency

Type boolean

Description If multiple currencies are used

pledges

Type ["Object"]

Description The sum of all pledges

salary_currency

Type string

Description DEPRECATED replaced by default_currency

salary_currency_symbol

Type string

Description DEPRECATED replaced by default_currency_symbol

totals

Type ["Object"]

Description The sum of all donations

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The account list the report was run on