The Insights API provides access to several system endpoints, each containing a set of standard data fields.
- In addition to the standard fields listed below, Administrators have the ability to select up to 10 Custom Fields of their choice to be included in the Volunteer Events API endpoint.
Insights API Volunteer Events Endpoint - Standard Fields
Please see the following table to view the standard fields available for Volunteer Events within the Insights API.
Field Name
|
Field Label
|
Field Type
|
Field Description
|
| eg_event_id | EG Event ID | Number | The unique CyberGrants identification number for a particular event. Each payment in CyberGrants will have a distinct EG event ID |
| create_date | Create Date | Date | The event’s create date |
| start_date | Start Date | Date | The event’s start date |
| end_date | End Date | Date | The event’s end date |
| start_time | Start Time | Timestamp | The event’s start time |
| end_time | End Time | Timestamp | The event’s end time |
| disposition | Disposition | String | The event’s disposition (or status) |
| event_name | Event Name | String | The event’s name or title |
| event_type | Event Type | String | The event’s category (i.e. human services, animals) |
| active_flag | Active Flag | String | A flag that indicates if the event is active |
| Cra Eligible Flag | Cra Eligible Flag | String | A flag that indicates whether or not the event has been marked as “CRA eligible” |
| eg_event_type_id | Eg Event Type Id | Number | The unique CyberGrants ID applicable to the event type |
| max_num_volunteers | Max Num Volunteers | Number | The maximum number of volunteers that can be added to an event |
| total_num_confirmed_volunteers | Total Confirmed Volunteers | Sum | The summed amount of confirmed volunteers |
| total_num_waitlisted_volunteers | Total Waitlisted Volunteers | Sum | The summed amount of waitlisted volunteers |
| address | Event Location Address | String | The event’s address |
| address2 | Event Location Address 2 | String | The event’s address 2 |
| city | Event Location City | String | The event’s city |
| country_id | Event Location Country | String | The event’s country (2-digit country ID) |
| province | Event Location Province | String | The event’s province |
| state_id | Event Location State | String | The event’s state (2-digit state ID) |
| zip | Event Location Zip | Zipcode | The event’s zip code |
| organization_id | Organization ID | Number | The unique CyberGrants identification number for a particular organization. Each organization in CyberGrants will have a distinct organization ID |
| proposal_type | Program | String | The proposal type or program name |
| virtual_flag | Virtual Flag | String | A flag that indicates if an event’s location is set as virtual |
What else do you need help with?
Not what you're looking for? Navigate to Understanding Insights API
