roadbeat Context Directory

roadbeat Context Directory

roadbeat Context Directory

roadbeat Context Directory

⌘K

⌘K

regionsGet region data statistics

Overview

API Overview
Authentication

Endpoints

goal-templates

GETList all goal trees
GETGet a goal tree with full category/subcategory structure
GETGet categories for a goal tree
GETList all subcategories for a goal tree
GETGet goal definitions for a subcategory
GETGet goal i18n translations for a subcategory
GETSearch goal templates via MeiliSearch
GETAutocomplete search for goals (top 8 results)
GETGet MeiliSearch index statistics
GETGet goal template statistics
GETGet git sync status

system

GETGet API usage statistics
GETGet most popular goal subcategories
GETHealth check endpoint
GETReadiness check for load balancers

countries

GETList all countries (ISO 3166-1)
GETGet country data statistics
GETGet country names translated into a specific locale
GETGet a single country by ISO 3166-1 alpha-2 code

regions

GETList all countries that have region data
GETGet region data statistics
GETGet all regions for a country
GETGet translated region names for a country and locale

districts

GETList all countries that have district data
GETGet district data statistics
GETGet all districts for a country
GETGet districts filtered by parent region

auth

POSTRegister a new user
POSTLogin and get JWT token
POSTRegister or link an account by email (system-to-system)
GETGet current user profile

user-goals

GETList all goals for the authenticated user
POSTCreate a new goal (adopt a goal template or create custom)
GETGet all active goals
GETGet active goals by time horizon
GETGet a single goal by ID
PATCHUpdate a goal
DELETEDelete a goal
POSTUpdate goal progress

user-context

GETGet user interest profile
PUTUpdate user interest profile
GETGet user location data
PUTUpdate user location data
GETGet user preferences
PUTUpdate user preferences

Appearance

Protected Content

Enter the password to access roadbeat Context Directory