favorite

Toggle Favorite

Changed on

Toggle a row favorite. Returns the new favorited state.

The body is optional, and must stay so: deploy-full ships the client before the API and a loaded tab keeps its old bundle indefinitely, so a required body would 422 every favorite click in that tab until the user happens to reload. It carries analytics context only and must never feed an authorization decision — this route admits AccessLevel.READ callers.

post/api/v1/favorite/{project_id}/{feature_id}

Request

  • Base URL
    https://api.maia-analytics.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.maia-analytics.com/api/v1/favorite/{project_id}/{feature_id}
  • Auth
    HTTP bearer

Path parameters

feature_idstring required

Request body

layer_idstring uuid nullable
visible_feature_idsstring[] nullable
row_positioninteger nullable
position_source'grid_viewport' | 'server_cursor' | 'map_stack'
total_rowsinteger nullable
is_groupedboolean nullable
filter_modelobject nullable
show_favorites_onlyboolean nullable
search_textstring nullable
comparison_scope'table_viewport' | 'map_stack' | 'navigation_neighbors' | 'unavailable'
source'table_cell' | 'table_shortcut' | 'detail_panel' required
session_idstring nullable

Response

Successful Response

favoritedboolean required

Changes

  • ab171f3fcfbeRevision changes
    • info

      added optional request body

    • info

      added the required property to the response with the status