Project Votes

Cast a vote for a listings project

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
projectIdinteger · max: 2147483647Required
Body
voteTypestring · enumRequiredPossible values:
amountintegerRequired
voteReasonstring · min: 1 · max: 50Optional
Responses
chevron-right
200

Successful response

application/json
post
/projects/{projectId}/votes

Get the current user's vote balance, optionally for a specific listings project and season

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
projectIdinteger · max: 2147483647Optional
yearintegerOptional
periodintegerOptional
Responses
chevron-right
200

Successful response

application/json
get
/projects/votes/balance

Get paginated list of project voters with their vote statistics and totals

get

Time Scope Options (scope parameter):

  • scope=global: All-time data from first vote to present

  • scope=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 needed

  • global-dates: Requires startDate and endDate (ISO date strings)

  • current-period: No additional parameters needed (default)

  • period: Requires year (number) and period (number)

Examples:

  • All-time: GET /projects/123/voters?scope=global

  • Date range: GET /projects/123/voters?scope=global-dates&startDate=2024-01-01&endDate=2024-12-31

  • Current period: GET /projects/123/voters (default) or GET /projects/123/voters?scope=current-period

  • Specific 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

Path parameters
projectIdinteger · max: 2147483647Required
Query parameters
orderBystring · enumOptionalDefault: scorePossible values:
orderDirectionstring · enumOptionalDefault: descPossible values:
sentimentstring · enumOptionalPossible values:
scopestring · enumOptionalDefault: current-periodPossible values:
startDatestringOptional
endDatestringOptional
yearintegerOptional
periodintegerOptional
limitinteger · max: 100OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
chevron-right
200

Successful response

application/json
get
/projects/{projectId}/voters

Reallocate votes for all users (Admin only)

post

Operation Types:

  • reset (default): Resets the voting period by advancing to the next period and allocating fresh votes

  • reallocate: Allocates additional votes for the current period without advancing the period

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
operationTypestring · enumOptionalDefault: new_period_resetPossible values:
Responses
chevron-right
200

Successful response

application/json
post
/projects/votes/reallocate

Get bulk user project vote totals with flexible time range support

get

Time Scope Options (scope parameter):

  • scope=global: All-time data from first vote to present

  • scope=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 needed

  • global-dates: Requires startDate and endDate (ISO date strings)

  • current-period: No additional parameters needed (default)

  • period: Requires year (number) and period (number)

Examples:

  • All-time: GET /projects/PROJECT_ID/bulk-totals?scope=global

  • Date range: GET /projects/PROJECT_ID/bulk-totals?scope=global-dates&startDate=2024-01-01&endDate=2024-12-31

  • Current period: GET /projects/PROJECT_ID/bulk-totals (default) or GET /projects/PROJECT_ID/bulk-totals?scope=current-period

  • Specific 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

Query parameters
projectIdinteger · max: 2147483647Required
profileIdsinteger[] · min: 1 · max: 100Required
scopestring · enumOptionalDefault: current-periodPossible values:
startDatestringOptional
endDatestringOptional
yearintegerOptional
periodintegerOptional
Responses
chevron-right
200

Successful response

application/json
get
/projects/votes/bulk-totals

Get project vote chart data with flexible time range and aggregation options

get

Time Scope Options (scope parameter):

  • scope=global: All-time data from first vote to present

  • scope=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 needed

  • global-dates: Requires startDate and endDate (ISO date strings)

  • current-period: No additional parameters needed (default)

  • period: Requires year (number) and period (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=global

  • Date range: GET /projects/123/chart?scope=global-dates&startDate=2024-01-01&endDate=2024-12-31

  • Current period: GET /projects/123/chart (default) or GET /projects/123/chart?scope=current-period

  • Specific 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

Path parameters
projectIdinteger · max: 2147483647Required
Query parameters
bucketstring · enumOptionalPossible values:
scopestring · enumOptionalDefault: current-periodPossible values:
startDatestringOptional
endDatestringOptional
yearintegerOptional
periodintegerOptional
Responses
chevron-right
200

Successful response

application/json
get
/projects/{projectId}/chart

Last updated