# Donation Histories

Donation Histories Documentation

## Donation History \[LIST]

Donation History \[LIST]

### Request

#### Endpoint

```
GET /api/v2/reports/donation_histories
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_\
The currency donation values should be converted to

_Required_\
No

**donor\_account\_id**

_Type_ `ID string`

_Description_\
Filter by donor account ID; Accepts comma separated ids

_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: 13m

_Required_\
No

### Response

#### Headers

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

#### Body

```json
{
  "data": [
    {
      "id": "2021-01-01",
      "type": "reports_donation_histories_periods",
      "attributes": {
        "converted_total": 0.0,
        "created_at": "2022-01-12T17:18:53Z",
        "end_date": "2021-01-31T10:59:59Z",
        "start_date": "2020-12-31T11:00:00Z",
        "totals": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-02-01",
      "type": "reports_donation_histories_periods",
      "attributes": {
        "converted_total": 0.0,
        "created_at": "2022-01-12T17:18:53Z",
        "end_date": "2021-02-28T10:59:59Z",
        "start_date": "2021-01-31T11:00:00Z",
        "totals": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-03-01",
      "type": "reports_donation_histories_periods",
      "attributes": {
        "converted_total": 0.0,
        "created_at": "2022-01-12T17:18:53Z",
        "end_date": "2021-03-31T10:59:59Z",
        "start_date": "2021-02-28T11:00:00Z",
        "totals": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-04-01",
      "type": "reports_donation_histories_periods",
      "attributes": {
        "converted_total": 0.0,
        "created_at": "2022-01-12T17:18:53Z",
        "end_date": "2021-04-30T11:59:59Z",
        "start_date": "2021-03-31T11:00:00Z",
        "totals": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-05-01",
      "type": "reports_donation_histories_periods",
      "attributes": {
        "converted_total": 0.0,
        "created_at": "2022-01-12T17:18:53Z",
        "end_date": "2021-05-31T11:59:59Z",
        "start_date": "2021-04-30T12:00:00Z",
        "totals": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-06-01",
      "type": "reports_donation_histories_periods",
      "attributes": {
        "converted_total": 0.0,
        "created_at": "2022-01-12T17:18:53Z",
        "end_date": "2021-06-30T11:59:59Z",
        "start_date": "2021-05-31T12:00:00Z",
        "totals": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-07-01",
      "type": "reports_donation_histories_periods",
      "attributes": {
        "converted_total": 0.0,
        "created_at": "2022-01-12T17:18:53Z",
        "end_date": "2021-07-31T11:59:59Z",
        "start_date": "2021-06-30T12:00:00Z",
        "totals": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-08-01",
      "type": "reports_donation_histories_periods",
      "attributes": {
        "converted_total": 0.0,
        "created_at": "2022-01-12T17:18:53Z",
        "end_date": "2021-08-31T11:59:59Z",
        "start_date": "2021-07-31T12:00:00Z",
        "totals": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-09-01",
      "type": "reports_donation_histories_periods",
      "attributes": {
        "converted_total": 0.0,
        "created_at": "2022-01-12T17:18:53Z",
        "end_date": "2021-09-30T10:59:59Z",
        "start_date": "2021-08-31T12:00:00Z",
        "totals": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-10-01",
      "type": "reports_donation_histories_periods",
      "attributes": {
        "converted_total": 0.0,
        "created_at": "2022-01-12T17:18:53Z",
        "end_date": "2021-10-31T10:59:59Z",
        "start_date": "2021-09-30T11:00:00Z",
        "totals": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-11-01",
      "type": "reports_donation_histories_periods",
      "attributes": {
        "converted_total": 0.0,
        "created_at": "2022-01-12T17:18:53Z",
        "end_date": "2021-11-30T10:59:59Z",
        "start_date": "2021-10-31T11:00:00Z",
        "totals": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-12-01",
      "type": "reports_donation_histories_periods",
      "attributes": {
        "converted_total": 0.0,
        "created_at": "2022-01-12T17:18:53Z",
        "end_date": "2021-12-31T10:59:59Z",
        "start_date": "2021-11-30T11:00:00Z",
        "totals": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2022-01-01",
      "type": "reports_donation_histories_periods",
      "attributes": {
        "converted_total": 0.0,
        "created_at": "2022-01-12T17:18:53Z",
        "end_date": "2022-01-31T10:59:59Z",
        "start_date": "2021-12-31T11:00:00Z",
        "totals": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    }
  ],
  "meta": {
    "filter": {
    },
    "total_pledges": 0.0,
    "monthly_goal": null,
    "display_currency": "USD",
    "average": 0.0,
    "average_ignore_zero": 0,
    "average_ignore_current": 0.0,
    "average_ignore_current_and_zero": 0
  }
}
```

### Fields

**data**

_Type_\
`[Donation Histories Period]`

_Description_\
An array of Donation Histories Periods
