Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Fundraising Page

fetchFundraisingPageOverview

Retrieves aggregate records for the Fundraising Page's transactions.

get/fundraising-pages/{fundraising_page}/overview

Path parameters

fundraising_pageinteger required
Example:2173528

The specified Fundraising Page ID

Query parameters

interval'daily' | 'weekly'
Example:weekly

Interval period of Fundraising Page overview

start_datestring
Example:2020-02-02 12:00:45

The date from which aggregation results will start. This is translated into a start_time, which is the beginning of the date presented in the timezone of the page's Campaign. If the Fundraising Page's Campaign has no associated timezone, this timezone will default to UTC.

end_datestring
Example:2020-02-02 12:00:45

The date at which aggregation results will end. This is translated into a end_time, which is the end of the date presented in the timezone of the page's Campaign. If the Fundraising Page's Campaign has no associated timezone, this timezone will default to UTC.

timezonestring
Example:America/Los_Angeles

Timezone for start_date and end_date.

Response

Success

end_timestring date-time nullable

The end time used to filter results represented in aggregation

start_timestring date-time nullable

The start time used to filter results represented in aggregation

timezonestring nullable

The timezone used to establish date ranges and start/end times for aggregation

Example response

{
  "end_time": "2016-02-11T08:00:00+0000",
  "start_time": "2016-02-11T08:00:00+0000",
  "timezone": "America/Los_Angeles",
  "metrics": {
    "soft_credits_amount": 50,
    "start_date": "2020-02-05T12:00:00",
    "donations_amount": 1439.2,
    "donors_count": 20,
    "fees_amount": 5.4,
    "gross_amount": 65,
    "net_amount": 59.6,
    "percent_to_goal": 1,
    "registrations_amount": 560.2,
    "transactions_count": 20
  }
}