Donation Monthly Totals

Donation Monthly Totals Documentation

Donation Monthly Total [GET]

Donation Monthly Total [GET]

Request

Endpoint

GET /api/v2/reports/donation_monthly_totals?filter[account_list_id]=537af50a-abaf-445a-ab60-92bf25f35f4c&filter[month_range]=2021-09-12+17%3A18%3A57+UTC..2021-11-12+17%3A18%3A57+UTC
Content-Type: application/vnd.api+json

Body

filter: {"account_list_id"=>"537af50a-abaf-445a-ab60-92bf25f35f4c", "month_range"=>"2021-09-12 17:18:57 UTC..2021-11-12 17:18:57 UTC"}

Parameters

Filters

account_list_id

Type string

Description The account list to run the report on

Required No

month_range

Type date

Description The date range to run the report on

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "reports::donationmonthlytotals",
    "type": "reports_donation_monthly_totals",
    "attributes": {
      "created_at": "2022-01-12T17:18:57Z",
      "donation_totals_by_month": [
        {
          "month": "2021-09-01",
          "totals_by_currency": [

          ]
        }
      ],
      "updated_at": null,
      "updated_in_db_at": null
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

donation_totals_by_month

Type object

Description donation totals by month

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.