Project Votes
Successful response
Invalid input data
Authorization not provided
Insufficient access
Internal server error
Successful response
Invalid input data
Authorization not provided
Insufficient access
Not found
Internal server error
Time Scope Options (scope parameter):
scope=global: All-time data from first vote to presentscope=global-dates: Custom date range (requires startDate & endDate)scope=current-period: Current voting period (default - backend determines automatically)scope=period: Specific voting period (requires year & period)
Parameter Requirements by Scope:
global: No additional parameters neededglobal-dates: RequiresstartDateandendDate(ISO date strings)current-period: No additional parameters needed (default)period: Requiresyear(number) andperiod(number)
Examples:
All-time:
GET /projects/123/voters?scope=globalDate range:
GET /projects/123/voters?scope=global-dates&startDate=2024-01-01&endDate=2024-12-31Current period:
GET /projects/123/voters(default) orGET /projects/123/voters?scope=current-periodSpecific period:
GET /projects/123/voters?scope=period&year=2024&period=3
Notes:
End dates extending into the future are automatically capped to the current time
Global scope uses all historical data for the project
scorePossible values: descPossible values: current-periodPossible values: 500Successful response
Invalid input data
Not found
Internal server error
Operation Types:
reset(default): Resets the voting period by advancing to the next period and allocating fresh votesreallocate: Allocates additional votes for the current period without advancing the period
new_period_resetPossible values: Successful response
Invalid input data
Authorization not provided
Insufficient access
Internal server error
Time Scope Options (scope parameter):
scope=global: All-time data from first vote to presentscope=global-dates: Custom date range (requires startDate & endDate)scope=current-period: Current voting period (default - backend determines automatically)scope=period: Specific voting period (requires year & period)
Parameter Requirements by Scope:
global: No additional parameters neededglobal-dates: RequiresstartDateandendDate(ISO date strings)current-period: No additional parameters needed (default)period: Requiresyear(number) andperiod(number)
Examples:
All-time:
GET /projects/PROJECT_ID/bulk-totals?scope=globalDate range:
GET /projects/PROJECT_ID/bulk-totals?scope=global-dates&startDate=2024-01-01&endDate=2024-12-31Current period:
GET /projects/PROJECT_ID/bulk-totals(default) orGET /projects/PROJECT_ID/bulk-totals?scope=current-periodSpecific period:
GET /projects/PROJECT_ID/bulk-totals?scope=period&year=2024&period=3
Notes:
End dates extending into the future are automatically capped to the current time
Global scope uses all historical data for the project
current-periodPossible values: Successful response
Invalid input data
Not found
Internal server error
Time Scope Options (scope parameter):
scope=global: All-time data from first vote to presentscope=global-dates: Custom date range (requires startDate & endDate)scope=current-period: Current voting period (default - backend determines automatically)scope=period: Specific voting period (requires year & period)
Parameter Requirements by Scope:
global: No additional parameters neededglobal-dates: RequiresstartDateandendDate(ISO date strings)current-period: No additional parameters needed (default)period: Requiresyear(number) andperiod(number)
Time Aggregation (bucket parameter):
Available buckets: '1 minute', '5 minutes', '15 minutes', '30 minutes', '1 hour', '2 hours', '6 hours', '12 hours', '1 day', '1 week', '1 month'
If bucket is omitted, the API auto-selects an optimal bucket size based on the time range to prevent excessive data points
For large time spans with small buckets, an error will be returned with a suggested larger bucket
Maximum data points: 2000 (for performance)
Examples:
All-time:
GET /projects/123/chart?scope=globalDate range:
GET /projects/123/chart?scope=global-dates&startDate=2024-01-01&endDate=2024-12-31Current period:
GET /projects/123/chart(default) orGET /projects/123/chart?scope=current-periodSpecific period:
GET /projects/123/chart?scope=period&year=2024&period=3
Notes:
End dates extending into the future are automatically capped to the current time
Global scope uses all historical data for the project
current-periodPossible values: Successful response
Invalid input data
Not found
Internal server error
Last updated