Topics

This API allows retrieving the topic tree of a dashboard, as configured in the build/setup/social page of the dashboard.

Get the topic tree

GET https://rest.synthesio.com/topic/v1/reports/DASHBOARD_ID HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "reports": [
      {
        "report_id": "DASHBOARD_ID",
        "topic_tree": {
          "topics": [
            {
              "meta": {
                "color": "#cfabd5"
              },
              "uuid": "c0ifp34bb64sdb6uhg0g",
              "name": "Topic 1",
              "topics": [
                {
                  "meta": {
                    "color": "#e3ea99"
                  },
                  "uuid": "c0ifp6ocu1i938rehe20",
                  "name": "Subtopic 1.a",
                  "topics": []
                },
                {
                  "meta": {
                    "color": "#f9cfa5"
                  },
                  "uuid": "c0ifqvcbb64sdb6uhg3g",
                  "name": "Subtopic 1.b",
                  "topics": []
                }
              ]
            },
            {
              "meta": {
                "color": "#6e6cbd"
              },
              "uuid": "cqtng49f85vtaekcut30",
              "name": "Topic 2",
              "topics": []
            }
          ]
        }
      }
    ]
  }
}