Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

GET https://topic-api.squirro.com/v0/(string: tenant)/projects/(id: project_id)/facets

Return Returns the known facets on a project. Every keyword that has ever been seen in the project's index will be included here.

Note: facets are never removed from an index.

 
Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
Headers:See Common Headers.
Status Codes:
  • 200 – Results returned.

See also Common Status Codes.

Returns:

Response fields:

  • facets – List of facets.

 

Code Block
js
js
{
    "facets": [
        {
            "display_name": "Issue Reporter",
            "name": "reporter",
            "data_type": "string",
            "group_name": "By field",
            "visible": true,
            "id": "fba89f9e644caeebe1a444d0cbf33364d50d9b49f91ce7bebf167cc1834ea550"
        },
        {
            "display_name": "Comment Count",
            "name": "comment_count",
            "data_type": "int",
            "group_name": "By field",
            "visible": true,
            "id": "a665d30abd88e397251bce536664bcdbfb8163c874459eebc813b42d7fc36def"
        }
    ]
}

 

...

POST https://topic-api.squirro.com/v0/(string: tenant)/projects/(id: project_id)/facets

Change Changes the settings for a single facet.

...

PUT https://topic-api.squirro.com/v0/(string: tenant)/projects/(id: project_id)/facets/(id: facet_id)

Change Changes the settings for a single facet.

...