Get the progress of a goal

GET /v1/client/promotions/progress/{goalId}

Header api token & Header user Query api token & Query user Header bearer token

Get Promotion Progress returns the progress of the user for the given goal.

Path parameters

goalId string Required

Responses

200 application/json

OK
Hide response attribute Show response attribute object
- data object
  
  Hide data attributes Show data attributes object
  
  goal_id string Required
  
  survey_completions_needed integer Required
  
  surveys_completed integer Required
  
  reward_usd string Required
  
  reward_currency string Required
  
  completed_at string(date-time)
404

Progress not found

GET /v1/client/promotions/progress/{goalId}

curl \
 --request GET 'https://api.bitlabs.ai/v1/client/promotions/progress/{goalId}' \
 --header "X-Api-Token: $API_KEY" \
 --header "X-User-Id: $API_KEY"

Response examples (200)

{
  "data": {
    "goal_id": "string",
    "survey_completions_needed": 42,
    "surveys_completed": 42,
    "reward_usd": "1.23",
    "reward_currency": "123.00",
    "completed_at": "2025-05-04T09:42:00Z"
  }
}