Retrieving Workflow

Listing the Workflow within your Project.

Workflow categories are stored within Projects. They represent special categorization behavior in the Analytics application:

  • Assignment - A Mention can be assigned to a user by another user.
  • Priority - A Mention can be given a priority level by a user.
  • Checked - A Mention can be marked as checked, which can indicate that it has been seen or interacted with by a user.
  • Status - A Mention can be given a status level by a user.

You can access them with the associated Project ID:

curl -X GET https://api.brandwatch.com/projects/398748937/workflow

The response will look like this:

[
  {
    "id": 587088,
    "name": "Assignment",
    "children": [
      {
        "id": 587093,
        "name": "colleague@example.com",
        "ordering": -1
      },
      {
        "id": 588907,
        "name": "anothercolleague@example.com",
        "ordering": -1
      }
    ]
  },
  {
    "id": 587075,
    "name": "Priority",
    "children": [
      {
        "id": 587076,
        "name": "high",
        "ordering": 1
      },
      {
        "id": 587077,
        "name": "medium",
        "ordering": 2
      },
      {
        "id": 587078,
        "name": "low",
        "ordering": 3
      }
    ]
  },
  {
    "id": 587091,
    "name": "Checked",
    "children": [
      {
        "id": 587092,
        "name": "yes",
        "ordering": -1
      }
    ]
  },
  {
    "id": 587079,
    "name": "Status",
    "children": [
      {
        "id": 587080,
        "name": "open",
        "ordering": 1
      },
      {
        "id": 587081,
        "name": "pending",
        "ordering": 2
      },
      {
        "id": 587082,
        "name": "closed",
        "ordering": 3
      }
    ]
  }
]

You can then use these Workflow category names when filtering or breaking down Mention calls.

Retrieving Workflow

Listing the Workflow within your Project.