NAV

Introduction

Bramble provides an API which makes it easy for developers to integrate external systems with our platform.

Our API is designed to handle the data integration needs for your business or application while making the integration process as painless as possible.

Through the API you can you seamlessly synchronize your key workflow events with Bramble check-ins, inventory volumes, quality scores and much more.

We designed the Bramble API around REST principles influenced by the JSON API specification.

This version of our API reference is auto-generated from an Open API specification.

API Endpoint

All API calls must be made to https://api.SUBDOMAIN.brmbl.io/v1.

JSON-only

All responses will be in JSON. Input data passed through the request body can be form-encoded or JSON-encoded. If using a JSON body, please specify the Content-Type header as application/json.

In the API dates are represented as ISO8601. Each entity like entries or groups has a unique integer ID.

Pagination

The Bramble API supports two ways to paginate collections. The most common way to paginate is through offset-based pagination which is often used where the list of items is of a fixed, predetermined length.

In most cases we will paginate requests returning more than 100 results. You can control pagination with the page parameter (object). Pages start at 1 and the first page will be returned if no page is specified.

curl https://api.YOURDOMAIN.brmbl.io/v1/groups?page[number]=3&page[size]=10 \
-H "authorization: Bearer ACCESS_TOKEN"

Most endpoints will return meta.pagination information in the response (see the example on the right).

  "meta": {
    "pagination": {
      "page_number": 1,
      "page_size": 25,
      "total_entries": 1,
      "total_pages": 1
    }
  }

In some cases an API endpoint supports marker-based pagination, either as an alternative to offset-based pagination or as a full replacement. Marker-based pagination is often used in cases where the length of the total set of items is either changing frequently, or where the total length might not be known upfront.

Sorting

Where an API returns a collection of items it often supports sorting of API responses.

Use the sort query parameters to sort the collection. Use a hyphen prefix to sort in

Not all API endpoints that return collections have support for sorting. Especially endpoints that use marker-based pagination often lack support for sorting the results.

Both the field and the direction to sort on is defined by the sort query parameter. Check the API endpoint's documentation for the possible options for this value.

curl https://api.YOURDOMAIN.brmbl.io/v1/users/?sort=full_name,-inserted_at \
-H "authorization: Bearer ACCESS_TOKEN"

Working with Dates

When working with dates, the Bramble API endpoints expect the following:

Dates in ISO 8601 format (YYYY-MM-DD). For example, date_happened in the TaskEvent type.

Timestamps (date and time) in RFC 3339 format. For example, a UTC time 2022-01-15T00:00:00Z.

An offset from UTC time indicates a time zone, such as 2013-01-15T00:00:00-08:00 (8 hours behind UTC time).

Clients must account for daylight savings time when providing offset dates.

Versioning

We follow the Global URL versioning scheme. This means that major changes to our API will be versioned in order to maintain backwards compatibility with existing integrations.

In order to notify consumers of upcoming upgrades, deprecated operations will be annotated using the OpenAPI spec

Getting Help or Contributing

We've made this document open source. Please report any issues or suggestions in the API doc issues. Any pull requests to improve this document are welcome too! If you need help using the API or need to discuss anything sensitive please message us at support@brmbl.io.

Errors

Each API call returns an HTTP status code that reflects the nature of the response. We have done our best to follow the HTTP status code conventions.

Any request that did not succeed will return a 4xx or 5xx error. The 4xx range means there was a problem with the request, like a missing parameter. The 5xx range means that something went wrong on our end.

Codes

The Bramble API returns the following HTTP status codes:

Code Description
200 OK Request succeeded
201 Created A resource was created
204 No Content Request succeeded but there is no response body
400 Bad Request Invalid request parameters
401 Unauthorized Incorrect or missing API key
403 Forbidden You do not have permission to view a resource or perform an action
404 Not Found The specified resource could not be found
409 Conflict The requested change cannot be done, because it conflicts with the Brmbl internal state of the resource
422 Unprocessable Entity The request body you sent is missing fields / fields have the wrong data type
500 Internal Server Error There was a problem on our end

Response format

Error responses are separated into two categories:

All error responses will have an errors array field, containing objects with these attributes:

Parameter Description
detail Explanation of the error
source.pointer Available when a specific request parameter was responsible
title A concise summary of the error
type (If available), a machine readable type of error, for example "AUTHENTICATION_FAILED"

Rate Limits

Each request is tracked by its unique IP. The limit is 1000 requests per minute. Hitting the limit will block further requests for that minute.

Please contact your Account Manager or Customer Success to request a limit increase.

Authentication

All calls to Bramble APIs are authenticated with an API key that an admin can generate within your Bramble app. Allowed resources can be customized per API key.

Please keep your API keys private.

API Keys created should never be exposed in untrusted contexts. Never put an API Key in client-side JavaScript, embed it in a web page, or otherwise allow users to access it. If an API Key is exposed, lost, or stolen, then it is compromised. Revoke compromised keys immediately from your Integration Settings page to prevent unauthorized access.

apiKey

Header: Authorization

Enter the token with the Bearer: prefix, e.g. "Bearer brmbl_ZLXZ4PYn_E34CJQSRtlmf0CXLsKFjMOf7".

Checkins

Creates a check-in for a user

Request: Create a check-in

curl -X POST https://api.COMPANY.brmbl.io/v1/checkins \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_ulhHcWMp_EnmPXXFObQet9V2640BvUOmD" \
-d @- << EOF

{
  "date": "2022-02-23",
  "user_id": "39510",
  "work_location": null
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:33Z",
      "updated_at": "2024-02-19T02:09:33Z",
      "work_location": null
    },
    "id": "32906",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkins/32906"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "39510",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39510",
          "self": "http://api.COMPANY.brmbl.io/v1/checkins/32906/relationships/user"
        }
      }
    },
    "type": "checkins"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkins/32906"
  }
}

Request: Create a check-in

curl -X POST https://api.COMPANY.brmbl.io/v1/checkins \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_BUcPYUVa_BPLryKHTgFxKGnLUtol5eVnF" \
-d @- << EOF

{
  "date": "2022-02-23",
  "user_id": "39520",
  "work_location": "distributed"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:33Z",
      "updated_at": "2024-02-19T02:09:33Z",
      "work_location": "distributed"
    },
    "id": "32912",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkins/32912"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "39520",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39520",
          "self": "http://api.COMPANY.brmbl.io/v1/checkins/32912/relationships/user"
        }
      }
    },
    "type": "checkins"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkins/32912"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid format. Expected :date",
      "source": {
        "pointer": "/date"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 409 Conflict

{
  "errors": [
    {
      "detail": "already entered on this day",
      "source": {
        "pointer": ":date"
      },
      "title": "Conflict"
    }
  ]
}

You can create a check-in for a user per day.

A Check-in is used to track where you plan on doing work, and is also referenced in how we create the check-in items.

Request

POST /v1/checkins

Responses

Status Description Schema
201 Checkin
401 Authentication Error
404 Not Found Error
409 Conflict
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Fetch a check-in by ID

Request: Returns a check-in

curl -X GET https://api.COMPANY.brmbl.io/v1/checkins/id/32907 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_7y7e9eFg_BGc9dfT1yFZs27uFTx9k7hjy" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-02-19T02:09:33Z",
      "updated_at": "2024-02-19T02:09:33Z",
      "work_location": "office"
    },
    "id": "32907",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkins/32907"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "39512",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39512",
          "self": "http://api.COMPANY.brmbl.io/v1/checkins/32907/relationships/user"
        }
      }
    },
    "type": "checkins"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkins/32907"
  }
}

Returns the check-in identified by an internal Bramble ID.

Request

GET /v1/checkins/id/{id}

Parameters

Parameter Description In Type Required Default Example
id Check-in ID path integer true 233
include Comma separated list of relationships to include. query array false user
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Checkin
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Fetch a check-in by user ID, and date

Request: Returns a check-in by user id and date

curl -X GET https://api.COMPANY.brmbl.io/v1/checkins/user/39534/date/2020-01-01 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_iBlN95vH_XSvXGs76GWBdgy7Td236yru2" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-02-19T02:09:33Z",
      "updated_at": "2024-02-19T02:09:33Z",
      "work_location": "office"
    },
    "id": "32918",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkins/32918"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "39534",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39534",
          "self": "http://api.COMPANY.brmbl.io/v1/checkins/32918/relationships/user"
        }
      }
    },
    "type": "checkins"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkins/32918"
  }
}

Response: 404 Not Found

{
  "errors": [
    {
      "code": "40401",
      "detail": "Could not find check-in with user_id: -1 and date: 2020-01-01",
      "status": "404",
      "title": "Resource Not Found"
    }
  ]
}

Returns the check-in identified by an internal Bramble user ID, and date.

Request

GET /v1/checkins/user/{user_id}/date/{date}

Parameters

Parameter Description In Type Required Default Example
user_id User ID path integer true 233
date Date path string true 2022-01-01
include Comma separated list of relationships to include. query array false user
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Checkin
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Checkin Items

Creates a user's check-in item

Request: Create a production task check-in item

curl -X POST https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_OaRpddCS_ROKUJGn9RHfpxbyNYYk1nqYF" \
-d @- << EOF

{
  "checkin_id": "32864",
  "cost_category_id": null,
  "date": "2022-02-23",
  "production_task_id": 12028,
  "user_id": "39258",
  "volume": 1
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:28Z",
      "minutes": "10.00",
      "updated_at": "2024-02-19T02:09:28Z",
      "volume": 1
    },
    "id": "70037",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70037"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "32864",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/32864",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70037/relationships/checkin"
        }
      },
      "production_task": {
        "data": {
          "id": "12028",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12028",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70037/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "39258",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39258",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70037/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70037"
  }
}

Request: Create a production task check-in item with cost category

curl -X POST https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_QWNmUwVI_O2xMauj0SUA2tB9uvVlfelgh" \
-d @- << EOF

{
  "checkin_id": "32869",
  "cost_category_id": "3749",
  "date": "2022-02-23",
  "production_task_id": 12033,
  "user_id": "39271",
  "volume": 1
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:28Z",
      "minutes": "10.00",
      "updated_at": "2024-02-19T02:09:28Z",
      "volume": 1
    },
    "id": "70045",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70045"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "32869",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/32869",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70045/relationships/checkin"
        }
      },
      "cost_category": {
        "data": {
          "id": "3749",
          "type": "cost_categories"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/cost_categories/3749",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70045/relationships/cost_category"
        }
      },
      "production_task": {
        "data": {
          "id": "12033",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12033",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70045/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "39271",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39271",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70045/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70045"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Failed to cast value to one of: no schemas validate",
      "source": {
        "pointer": "/"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 409 Conflict

{
  "errors": [
    {
      "detail": "already entered on this day",
      "source": {
        "pointer": ":production_task_id"
      },
      "title": "Conflict"
    }
  ]
}

Request: Create a supporting task check-in item

curl -X POST https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_T3tonypX_5dGCQ3xj8xdHZ4cq8Y4sJGpn" \
-d @- << EOF

{
  "checkin_id": "32848",
  "date": "2022-02-23",
  "minutes": 450,
  "supporting_task_id": "8911",
  "user_id": "39215"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:27Z",
      "minutes": "450",
      "updated_at": "2024-02-19T02:09:27Z",
      "volume": null
    },
    "id": "70009",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70009"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "32848",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/32848",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70009/relationships/checkin"
        }
      },
      "supporting_task": {
        "data": {
          "id": "8911",
          "type": "supporting_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/8911",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70009/relationships/supporting_task"
        }
      },
      "user": {
        "data": {
          "id": "39215",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39215",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70009/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70009"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Failed to cast value to one of: no schemas validate",
      "source": {
        "pointer": "/"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 409 Conflict

{
  "errors": [
    {
      "detail": "already entered on this day",
      "source": {
        "pointer": ":supporting_task_id"
      },
      "title": "Conflict"
    }
  ]
}

Creates user's check-in item for a day, could be a production task or supporting task.

Request

POST /v1/checkin_items

Parameters

Parameter Description In Type Required Default Example
x-lineage-data Log optional lineage data (a Base 64 encoded JSON object) with which to build a history. header string false

Responses

Status Description Schema
201 Checkin Item Response
401 Authentication Error
404 Not Found Error
409 Conflict
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Retrieve a check-in item.

Request: Returns a check-in item

curl -X GET https://api.COMPANY.brmbl.io/v1/checkin_items/70002 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_Y7lzr1V1_Ro1BfBqOQKuDeQp0yO8DKzqE" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-02-19T02:09:27Z",
      "minutes": "150.00",
      "updated_at": "2024-02-19T02:09:27Z",
      "volume": 15
    },
    "id": "70002",
    "links": {
      "self": "http://company.brmbl.io/v1/checkin_items/70002"
    },
    "relationships": {},
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://company.brmbl.io/v1/checkin_items/70002"
  }
}

Request: Returns a check-in item

curl -X GET https://api.COMPANY.brmbl.io/v1/checkin_items/70024?include=production_task \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_CFWM2m7F_fv7Z0bKv4qDaNEbRhhBg1Q5O" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-02-19T02:09:27Z",
      "minutes": "150.00",
      "updated_at": "2024-02-19T02:09:27Z",
      "volume": 15
    },
    "id": "70024",
    "links": {
      "self": "http://company.brmbl.io/v1/checkin_items/70024"
    },
    "relationships": {
      "production_task": {
        "data": {
          "id": "12020",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://company.brmbl.io/v1/production_tasks/12020",
          "self": "http://company.brmbl.io/v1/checkin_items/70024/relationships/production_task"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [
    {
      "attributes": {
        "description": "pt-TvSOpZjj",
        "entry_mode": "MANUAL",
        "improvement_category": "rpa",
        "inserted_at": "2024-02-19T02:09:27Z",
        "name": "TaskB",
        "state": "detached",
        "updated_at": "2024-02-19T02:09:27Z"
      },
      "id": "12020",
      "links": {
        "self": "http://company.brmbl.io/v1/production_tasks/12020"
      },
      "relationships": {},
      "type": "production_tasks"
    }
  ],
  "links": {
    "self": "http://company.brmbl.io/v1/checkin_items/70024"
  }
}

Request: Returns a check-in item

curl -X GET https://api.COMPANY.brmbl.io/v1/checkin_items/70025?include=supporting_task \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_CFWM2m7F_fv7Z0bKv4qDaNEbRhhBg1Q5O" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-02-19T02:09:27Z",
      "minutes": "60.00",
      "updated_at": "2024-02-19T02:09:27Z",
      "volume": null
    },
    "id": "70025",
    "links": {
      "self": "http://company.brmbl.io/v1/checkin_items/70025"
    },
    "relationships": {
      "supporting_task": {
        "data": {
          "id": "8916",
          "type": "supporting_tasks"
        },
        "links": {
          "related": "http://company.brmbl.io/v1/supporting_tasks/8916",
          "self": "http://company.brmbl.io/v1/checkin_items/70025/relationships/supporting_task"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [
    {
      "attributes": {
        "category": "meet",
        "description": "MadxICaL",
        "inserted_at": "2024-02-19T02:09:27Z",
        "name": "MadxICaL",
        "state": "active",
        "updated_at": "2024-02-19T02:09:27Z"
      },
      "id": "8916",
      "links": {
        "self": "http://company.brmbl.io/v1/supporting_tasks/8916"
      },
      "relationships": {},
      "type": "supporting_tasks"
    }
  ],
  "links": {
    "self": "http://company.brmbl.io/v1/checkin_items/70025"
  }
}

You can fetch the details of a single item.

Request

GET /v1/checkin_items/{id}

Parameters

Parameter Description In Type Required Default Example
id Checkin item ID to retrieve. path integer true 233
include Comma separated list of relationships to include. query array false users
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Checkin Item Response
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

List all check-in items

Request: List of check-in items (filtered by date)

curl -X GET https://api.COMPANY.brmbl.io/v1/checkin_items?date=2020-01-02&page[number]=1&page[size]=10&sort=date&fields[checkin_items]=volume,date \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_ouaiNFQJ_LWzqnxmSRev4mY2vyuUW8eUf" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "date": "2020-01-02",
        "volume": 15
      },
      "id": "70017",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70017"
      },
      "relationships": {},
      "type": "checkin_items"
    },
    {
      "attributes": {
        "date": "2020-01-02",
        "volume": 20
      },
      "id": "70018",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70018"
      },
      "relationships": {},
      "type": "checkin_items"
    }
  ],
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items?date=2020-01-02&fields%5Bcheckin_items%5D=volume%2Cdate&page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=date"
  },
  "meta": {
    "pagination": {
      "page_number": 1,
      "page_size": 10,
      "total_entries": 2,
      "total_pages": 1
    }
  }
}

You can fetch a list of all check-in items.

Request

GET /v1/checkin_items

Parameters

Parameter Description In Type Required Default Example
date Filter results for this date query string false 2022-02-28
user_id Filter results with this Bramble user ID query integer false 12
page query Page false
sort Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. query array false -date,-volume
include Comma separated list of relationships to include. query array false users
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 CheckinItems
401 Authentication Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Updates a user's check-in item

Request: Update a production task check-in item. Note that this will replace the existing values.

curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items/70028 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_F8nuiiZp_9knpkSXc1bZhKymSJ5XUNhVo" \
-d @- << EOF

{
  "checkin_id": "32858",
  "cost_category_id": null,
  "date": "2022-02-23",
  "production_task_id": 12022,
  "user_id": "39243",
  "volume": 1
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:28Z",
      "minutes": "10.00",
      "updated_at": "2024-02-19T02:09:28Z",
      "volume": 1
    },
    "id": "70028",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70028"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "32858",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/32858",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70028/relationships/checkin"
        }
      },
      "production_task": {
        "data": {
          "id": "12022",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12022",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70028/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "39243",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39243",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70028/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70028"
  }
}

Request: Update a production task check-in item with a cost category. Note that this will replace the existing values.

curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items/70019 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_kRZgbVdc_eMrzES0zUvxwNYmKQF5UQgcp" \
-d @- << EOF

{
  "checkin_id": "32853",
  "cost_category_id": "3738",
  "date": "2022-02-23",
  "production_task_id": 12017,
  "user_id": "39230",
  "volume": 1
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:27Z",
      "minutes": "10.00",
      "updated_at": "2024-02-19T02:09:27Z",
      "volume": 1
    },
    "id": "70019",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70019"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "32853",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/32853",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70019/relationships/checkin"
        }
      },
      "cost_category": {
        "data": {
          "id": "3738",
          "type": "cost_categories"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/cost_categories/3738",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70019/relationships/cost_category"
        }
      },
      "production_task": {
        "data": {
          "id": "12017",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12017",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70019/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "39230",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39230",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70019/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70019"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Failed to cast value to one of: no schemas validate",
      "source": {
        "pointer": "/"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 409 Conflict

{
  "errors": [
    {
      "detail": "entry is locked",
      "source": {
        "pointer": ":date"
      },
      "title": "Conflict"
    }
  ]
}

Request: Update a supporting task check-in item. Note that this will replace the existing values.

curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items/70007 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_313QX6Ud_d6smGD6dqYsA0QXH89VehA0T" \
-d @- << EOF

{
  "checkin_id": "32846",
  "date": "2022-02-23",
  "minutes": 450,
  "supporting_task_id": "8909",
  "user_id": "39210"
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:27Z",
      "minutes": "450",
      "updated_at": "2024-02-19T02:09:27Z",
      "volume": null
    },
    "id": "70007",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70007"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "32846",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/32846",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70007/relationships/checkin"
        }
      },
      "supporting_task": {
        "data": {
          "id": "8909",
          "type": "supporting_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/8909",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70007/relationships/supporting_task"
        }
      },
      "user": {
        "data": {
          "id": "39210",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39210",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70007/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70007"
  }
}

Updates user's check-in item for a day, could be a production task or supporting task.

Request

PATCH /v1/checkin_items/{id}

Parameters

Parameter Description In Type Required Default Example
x-lineage-data Log optional lineage data (a Base 64 encoded JSON object) with which to build a history. header string false

Responses

Status Description Schema
200 Checkin Item Response
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Upserts a user's production task check-in item.

Request: Upserts a not existing production task check-in item will create a new one

curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_hpon8ahw_ZseaG90Q08QpW6y8aheFlNCG" \
-d @- << EOF

{
  "checkin_id": "32843",
  "cost_category_id": null,
  "date": "2022-02-23",
  "production_task_id": 12007,
  "user_id": "39204",
  "volume": 1
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:27Z",
      "minutes": "10.00",
      "updated_at": "2024-02-19T02:09:27Z",
      "volume": 1
    },
    "id": "70004",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70004"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "32843",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/32843",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70004/relationships/checkin"
        }
      },
      "production_task": {
        "data": {
          "id": "12007",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12007",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70004/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "39204",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39204",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70004/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70004"
  }
}

Request: Upserts a not existing production task check-in item will create a new one

curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_8eKVXD0u_wYjc79zEmGgcCX1IrZfp8R8P" \
-d @- << EOF

{
  "checkin_id": "32850",
  "cost_category_id": "3736",
  "date": "2022-02-23",
  "production_task_id": 12014,
  "user_id": "39221",
  "volume": 1
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:27Z",
      "minutes": "10.00",
      "updated_at": "2024-02-19T02:09:27Z",
      "volume": 1
    },
    "id": "70013",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70013"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "32850",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/32850",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70013/relationships/checkin"
        }
      },
      "cost_category": {
        "data": {
          "id": "3736",
          "type": "cost_categories"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/cost_categories/3736",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70013/relationships/cost_category"
        }
      },
      "production_task": {
        "data": {
          "id": "12014",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12014",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70013/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "39221",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39221",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70013/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70013"
  }
}

Request: Upsert an existing production task check-in item

curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_U17Z2jYo_3x2zkE3CNfJ6eOFoJVoqQfXf" \
-d @- << EOF

{
  "checkin_id": "32851",
  "cost_category_id": null,
  "date": "2022-02-23",
  "production_task_id": 12015,
  "user_id": "39224",
  "volume": 1
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:27Z",
      "minutes": "20.00",
      "updated_at": "2024-02-19T02:09:28Z",
      "volume": 2
    },
    "id": "70015",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70015"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "32851",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/32851",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70015/relationships/checkin"
        }
      },
      "production_task": {
        "data": {
          "id": "12015",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12015",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70015/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "39224",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39224",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70015/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70015"
  }
}

Response: 409 Conflict

{
  "errors": [
    {
      "detail": "cannot exceed 24h",
      "source": {
        "pointer": ":minutes"
      },
      "title": "Conflict"
    }
  ]
}

Response: 409 Conflict

{
  "errors": [
    {
      "detail": "cannot exceed 24h",
      "source": {
        "pointer": ":minutes"
      },
      "title": "Conflict"
    }
  ]
}

Request: Approved items are unlocked, their volume and minutes incremented, and then left in a rejected state (for later resubmission and approval).

curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_xo5ePxzF_gbNbBuBgQNtOezsOUZ0fCTt5" \
-d @- << EOF

{
  "checkin_id": "32841",
  "cost_category_id": null,
  "date": "2022-02-23",
  "production_task_id": 12005,
  "user_id": "39199",
  "volume": 1
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:26Z",
      "minutes": "20.00",
      "updated_at": "2024-02-19T02:09:26Z",
      "volume": 2
    },
    "id": "70000",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70000"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "32841",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/32841",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70000/relationships/checkin"
        }
      },
      "production_task": {
        "data": {
          "id": "12005",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12005",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70000/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "39199",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39199",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70000/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70000"
  }
}

Request: Submitted entries are unlocked, their volume and minutes incremented, and then resubmitted.

curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_hqHMU8lT_W9xfkbkfwMzvlgodbJvXxFoF" \
-d @- << EOF

{
  "checkin_id": "32865",
  "cost_category_id": null,
  "date": "2022-02-23",
  "production_task_id": 12029,
  "user_id": "39261",
  "volume": 1
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:28Z",
      "minutes": "20.00",
      "updated_at": "2024-02-19T02:09:28Z",
      "volume": 2
    },
    "id": "70039",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70039"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "32865",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/32865",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70039/relationships/checkin"
        }
      },
      "production_task": {
        "data": {
          "id": "12029",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12029",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70039/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "39261",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39261",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70039/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/70039"
  }
}

Response: 409 Conflict

{
  "errors": [
    {
      "detail": "cannot exceed 24h",
      "source": {
        "pointer": ":minutes"
      },
      "title": "Conflict"
    }
  ]
}

Tries to create a user's production task check-in item. If an existing item exists, it will update the existing one instead

Request

PUT /v1/checkin_items

Parameters

Parameter Description In Type Required Default Example
x-lineage-data Log optional lineage data (a Base 64 encoded JSON object) with which to build a history. header string false

Responses

Status Description Schema
200 Checkin Item Response
201 Checkin Item Response
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Contact Center

Create an Agent Metric set

Request: Create daily metrics for an agent

curl -X POST https://api.COMPANY.brmbl.io/v1/agent_daily_metrics \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_g0y9Mc5J_anWuz0kOrp5HmwUw2Um3uH2w" \
-d @- << EOF

{
  "after_call_work_seconds": null,
  "aux_seconds": null,
  "available_seconds": null,
  "conversations": 3,
  "date": "2012-12-13",
  "handle_seconds": null,
  "hold_seconds": null,
  "idle_seconds": null,
  "staffed_seconds": null,
  "talk_seconds": null,
  "user_id": 39590
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "after_call_work_seconds": null,
      "aux_seconds": null,
      "available_seconds": null,
      "conversations": 3,
      "date": "2012-12-13",
      "handle_seconds": null,
      "hold_seconds": null,
      "idle_seconds": null,
      "staffed_seconds": null,
      "talk_seconds": null,
      "user_id": 39590
    },
    "id": "451",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/451"
    },
    "relationships": {},
    "type": "agent_daily_metrics"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/451"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid format. Expected :date",
      "source": {
        "pointer": "/date"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 409 Conflict

{
  "errors": [
    {
      "detail": "Agent data already exists for the given day",
      "source": {
        "pointer": ":date"
      },
      "title": "Conflict"
    }
  ]
}

You can record several agent metrics on a day-by-day basis from an Automatic Call Distribution (ACD) system.

Request

POST /v1/agent_daily_metrics

Responses

Status Description Schema
201 Agent Daily Metrics Response
401 Authentication Error
404 Not Found Error
409 Conflict
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Create an Agent Queue Metric set

Request: Create queue metrics for an agent

curl -X POST https://api.COMPANY.brmbl.io/v1/agent_queue_metrics \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_h7IfKvSY_18gziqXlMoiqgcr2TrHtT3e3" \
-d @- << EOF

{
  "after_call_work_seconds": null,
  "conversations": 3,
  "date": "2012-12-13",
  "handle_seconds": null,
  "hold_seconds": null,
  "production_task_id": 12100,
  "quality_score": 0.8,
  "talk_seconds": null,
  "user_id": 39604
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "after_call_work_seconds": null,
      "conversations": 3,
      "date": "2012-12-13",
      "entry_id": 70086,
      "handle_seconds": null,
      "hold_seconds": null,
      "production_task_id": 12100,
      "talk_seconds": null,
      "user_id": 39604
    },
    "id": "727",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/727"
    },
    "relationships": {
      "checkin_item": {
        "data": {
          "id": "70086",
          "type": "checkin_items"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkin_items/70086",
          "self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/727/relationships/checkin_item"
        }
      },
      "quality_score": {
        "data": {
          "id": "1699",
          "type": "quality_scores"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/quality_scores/1699",
          "self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/727/relationships/quality_score"
        }
      }
    },
    "type": "agent_queue_metrics"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/727"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid format. Expected :date",
      "source": {
        "pointer": "/date"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 409 Conflict

{
  "errors": [
    {
      "detail": "Agent Queue Metrics already exist for the given agent, queue, and day.",
      "source": {
        "pointer": ":entry"
      },
      "title": "Conflict"
    }
  ]
}

You can record several agent metrics on a per-queue, per-day basis from an Automatic Call Distribution (ACD) system.

Request

POST /v1/agent_queue_metrics

Responses

Status Description Schema
201 Agent Queue Metrics Response
401 Authentication Error
404 Not Found Error
409 Conflict
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Insert contact-center queue-data on a day-by-day basis.

Request: Create daily metrics for a queue

curl -X POST https://api.COMPANY.brmbl.io/v1/queue_daily_metrics \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_xU5nCFDm_PFgor7BDu0TwrM3wXNC4I9aW" \
-d @- << EOF

{
  "after_call_work_seconds": null,
  "conversations": 3,
  "date": "2012-12-13",
  "handle_seconds": null,
  "hold_seconds": null,
  "production_task_id": 12105,
  "service_level": 0.6,
  "talk_seconds": null
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "after_call_work_seconds": null,
      "conversations": 3,
      "date": "2012-12-13",
      "handle_seconds": null,
      "hold_seconds": null,
      "queue_id": 12105,
      "talk_seconds": null
    },
    "id": "602",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/602"
    },
    "relationships": {
      "service_level": {
        "data": {
          "id": "1319",
          "type": "service_levels"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/service_levels/1319",
          "self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/602/relationships/service_level"
        }
      }
    },
    "type": "queue_daily_metrics"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/602"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid format. Expected :date",
      "source": {
        "pointer": "/date"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 409 Conflict

{
  "errors": [
    {
      "detail": "Queue data already exists for the given day",
      "source": {
        "pointer": ":date"
      },
      "title": "Conflict"
    }
  ]
}

Use this endpoint to import contact-center queue-data on a day-by-day basis.

Request

POST /v1/queue_daily_metrics

Responses

Status Description Schema
201 Agent Queue Metrics Response
401 Authentication Error
404 Not Found Error
409 Conflict
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Delete an Agent Daily Metrics set

Request: Deletes agent metrics and updates or deletes the associated entry

curl -X DELETE https://api.COMPANY.brmbl.io/v1/agent_daily_metrics/454 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_cZCRNGDa_pM2lsVBeEoaOHgHp9jlKD8zY" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "after_call_work_seconds": null,
      "aux_seconds": null,
      "available_seconds": null,
      "conversations": 279,
      "date": "2024-02-19",
      "handle_seconds": null,
      "hold_seconds": null,
      "idle_seconds": null,
      "staffed_seconds": null,
      "talk_seconds": null,
      "user_id": 39596
    },
    "id": "454",
    "links": {
      "self": "http://company.brmbl.io/v1/agent_daily_metrics/454"
    },
    "relationships": {},
    "type": "agent_daily_metrics"
  },
  "included": [],
  "links": {
    "self": "http://company.brmbl.io/v1/agent_daily_metrics/454"
  }
}

Response: 404 Not Found

{
  "errors": [
    {
      "code": "40401",
      "detail": "The given agent daily metrics could not be found.",
      "status": "404",
      "title": "Agent Daily Metrics Not Found"
    }
  ]
}

Delete an Agent Daily Metrics set.

Request

DELETE /v1/agent_daily_metrics/{id}

Parameters

Parameter Description In Type Required Default Example
id The ID of the agent daily metrics to delete. path integer true 123

Responses

Status Description Schema
200 Agent Daily Metrics Response
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Delete an Agent Queue Metrics set

Request: Deletes an agent queue dataset and updates the entry

curl -X DELETE https://api.COMPANY.brmbl.io/v1/agent_queue_metrics/726 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_4zBoHxMS_oUYAPZQxLYeVpnoRMGZ1SXoy" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "after_call_work_seconds": null,
      "conversations": 11,
      "date": "2024-02-18",
      "entry_id": 70085,
      "handle_seconds": null,
      "hold_seconds": null,
      "production_task_id": 12099,
      "talk_seconds": 500,
      "user_id": 39602
    },
    "id": "726",
    "links": {
      "self": "http://company.brmbl.io/v1/agent_queue_metrics/726"
    },
    "relationships": {},
    "type": "agent_queue_metrics"
  },
  "included": [],
  "links": {
    "self": "http://company.brmbl.io/v1/agent_queue_metrics/726"
  }
}

Response: 404 Not Found

{
  "errors": [
    {
      "code": "40401",
      "detail": "The given agent queue metrics could not be found.",
      "status": "404",
      "title": "Agent Queue Metrics Not Found"
    }
  ]
}

Delete an Agent Queue Metrics set.

Request

DELETE /v1/agent_queue_metrics/{id}

Parameters

Parameter Description In Type Required Default Example
id The ID of the agent queue metrics to delete. path integer true 233

Responses

Status Description Schema
200 Agent Queue Metrics Response
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Delete a Queue Daily Metrics set

Request: Deletes queue metrics and updates or deletes the associated entry

curl -X DELETE https://api.COMPANY.brmbl.io/v1/queue_daily_metrics/605 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_wjHxhWAl_vTCOkoRdXVrVOk3ZoTSoN0ym" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "after_call_work_seconds": null,
      "conversations": 395,
      "date": "2024-02-19",
      "handle_seconds": null,
      "hold_seconds": null,
      "queue_id": 12108,
      "talk_seconds": null
    },
    "id": "605",
    "links": {
      "self": "http://company.brmbl.io/v1/queue_daily_metrics/605"
    },
    "relationships": {},
    "type": "queue_daily_metrics"
  },
  "included": [],
  "links": {
    "self": "http://company.brmbl.io/v1/queue_daily_metrics/605"
  }
}

Response: 404 Not Found

{
  "errors": [
    {
      "code": "40401",
      "detail": "The given queue daily metrics could not be found.",
      "status": "404",
      "title": "Queue Daily Metrics Not Found"
    }
  ]
}

Delete a Queue Daily Metrics set.

Request

DELETE /v1/queue_daily_metrics/{id}

Parameters

Parameter Description In Type Required Default Example
id The ID of the queue daily metrics to delete. path integer true 123

Responses

Status Description Schema
200 Agent Queue Metrics Response
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Cost Categories

Retrieve a cost category

Request: Returns a cost category

curl -X GET https://api.COMPANY.brmbl.io/v1/cost_categories/3755 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_wKJ7CZeu_Z2AQGctXHI1jPQakgFq3p7xx" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "description": "pt-R6gAHSiM",
      "inserted_at": "2024-02-19T02:09:34Z",
      "name": "Auto",
      "state": "active",
      "updated_at": "2024-02-19T02:09:34Z"
    },
    "id": "3755",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/cost_categories/3755"
    },
    "relationships": {},
    "type": "cost_categories"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/cost_categories/3755"
  }
}

You can fetch the details of a single cost category.

Request

GET /v1/cost_categories/{id}

Parameters

Parameter Description In Type Required Default Example
id Cost category ID to retrieve. path integer true 233

Responses

Status Description Schema
200 Cost Category Response
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

List all cost categories

Request: List of cost categories

curl -X GET https://api.COMPANY.brmbl.io/v1/cost_categories?page[number]=1&page[size]=2&sort=name&fields[cost_categories]=name,state \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_o0LygL5r_gqAQibxI19Tvk2mP7IMULFvR" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "name": "Auto",
        "state": "active"
      },
      "id": "3753",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/cost_categories/3753"
      },
      "relationships": {},
      "type": "cost_categories"
    },
    {
      "attributes": {
        "name": "Property",
        "state": "active"
      },
      "id": "3754",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/cost_categories/3754"
      },
      "relationships": {},
      "type": "cost_categories"
    }
  ],
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/cost_categories?fields%5Bcost_categories%5D=name%2Cstate&page%5Bnumber%5D=1&page%5Bsize%5D=2&sort=name"
  },
  "meta": {
    "pagination": {
      "page_number": 1,
      "page_size": 2,
      "total_entries": 2,
      "total_pages": 1
    }
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Unexpected field: FOO",
      "source": {
        "pointer": "/FOO"
      },
      "title": "Invalid value"
    }
  ]
}

You can fetch a list of all cost categories.

You can optionally filter the list by state.

Request

GET /v1/cost_categories

Parameters

Parameter Description In Type Required Default Example
state Filter cost categories by given states (comma-separated) query array false active,archived
page query Page false
sort Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. query array false -name,updated_at,-state
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Cost Categories
401 Authentication Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Friction Types

Retrieve a friction type

Request: Retrieve a supporting task

curl -X GET https://api.COMPANY.brmbl.io/v1/friction_types/5351 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_PK6gmx3h_G0HjJosAenlbJTJb4sdOQH0N" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "category": "downtime",
      "description": "iKOvnfZK",
      "inserted_at": "2024-02-19T02:09:34Z",
      "name": "Power Outage",
      "state": "active",
      "updated_at": "2024-02-19T02:09:34Z"
    },
    "id": "5351",
    "links": {
      "self": "http://www.example.com/v1/friction_types/5351"
    },
    "relationships": {},
    "type": "friction_types"
  },
  "included": [],
  "links": {
    "self": "http://www.example.com/v1/friction_types/5351"
  }
}

You can fetch the details of a single friction type.

Request

GET /v1/friction_types/{id}

Parameters

Parameter Description In Type Required Default Example
id Friction Type ID to retrieve. path integer true 32

Responses

Status Description Schema
200 FrictionType
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

List all Friction Types

Request: List all friction types (filtered).

curl -X GET https://api.COMPANY.brmbl.io/v1/friction_types?state=active \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_eOhji2Xu_YVMGLPpvx7umstmD1ly7kTlA" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "category": "downtime",
        "description": "PVJdUpRh",
        "inserted_at": "2024-02-19T02:09:34Z",
        "name": "Power Outage",
        "state": "active",
        "updated_at": "2024-02-19T02:09:34Z"
      },
      "id": "5355",
      "links": {
        "self": "http://www.example.com/v1/friction_types/5355"
      },
      "relationships": {},
      "type": "friction_types"
    }
  ],
  "included": [],
  "links": {
    "self": "http://www.example.com/v1/friction_types?state=active"
  },
  "meta": {
    "pagination": {
      "page_number": 1,
      "page_size": 25,
      "total_entries": 1,
      "total_pages": 1
    }
  }
}

You can fetch a list of all friction types.

Request

GET /v1/friction_types

Parameters

Parameter Description In Type Required Default Example
category Filter the friction type's in given category(ies). query array false downtime,coaching
state Filter by the friction type's status. query array false active,archived
page query Page false
sort Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. query array false -name,updated_at,-state
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Friction Types
401 Authentication Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Groups

Retrieve a group

Request: Returns a group

curl -X GET https://api.COMPANY.brmbl.io/v1/groups/35586?include=users \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_6pKJxLfH_QWg3Dt8WJF7Fbb53OdcExdaw" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "inserted_at": "2024-02-19T02:09:32Z",
      "name": "Sales",
      "state": "active",
      "updated_at": "2024-02-19T02:09:32Z"
    },
    "id": "35586",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/groups/35586"
    },
    "relationships": {
      "users": {
        "data": [
          {
            "id": "39467",
            "type": "users"
          }
        ],
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users",
          "self": "http://api.COMPANY.brmbl.io/v1/groups/35586/relationships/users"
        }
      }
    },
    "type": "groups"
  },
  "included": [
    {
      "attributes": {
        "account_role": null,
        "email": "solon2085@shanahan.org",
        "full_name": "Some User",
        "inserted_at": "2024-02-19T02:09:32Z",
        "preferred_first_name": "Some",
        "state": "invited",
        "team_role": "team_contributor",
        "timezone": "Etc/UTC",
        "updated_at": "2024-02-19T02:09:32Z"
      },
      "id": "39467",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/users/39467"
      },
      "relationships": {},
      "type": "users"
    }
  ],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/groups/35586"
  }
}

You can fetch the details of a single group, using it's Bramble ID.

Request

GET /v1/groups/{id}

Parameters

Parameter Description In Type Required Default Example
id The ID of the group to fetch path integer true 233
include Comma separated list of relationships to include. query array false parent,users
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Group Response
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

List all groups

Request: List of groups (filtered by parent_id)

curl -X GET https://api.COMPANY.brmbl.io/v1/groups?ancestors_id=35563&page[number]=1&page[size]=2&sort=name&fields[groups]=name,state \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_SGjeYL1b_aSKOpBPuOgNAfvcl73gZpSbl" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "name": "division",
        "state": "active"
      },
      "id": "35564",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/groups/35564"
      },
      "relationships": {},
      "type": "groups"
    },
    {
      "attributes": {
        "name": "root",
        "state": "active"
      },
      "id": "35563",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/groups/35563"
      },
      "relationships": {},
      "type": "groups"
    }
  ],
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/groups?ancestors_id=35563&fields%5Bgroups%5D=name%2Cstate&page%5Bnumber%5D=1&page%5Bsize%5D=2&sort=name"
  },
  "meta": {
    "pagination": {
      "page_number": 1,
      "page_size": 2,
      "total_entries": 3,
      "total_pages": 2
    }
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Unexpected field: FOO",
      "source": {
        "pointer": "/FOO"
      },
      "title": "Invalid value"
    }
  ]
}

You can fetch a list of all groups.

You can optionally filter the list by group status, or by to all groups that are descendant from a given parent group (using root_group_ids).

Request

GET /v1/groups

Parameters

Parameter Description In Type Required Default Example
ancestors_id Filter groups who have these IDs above them in the group hierarchy query array false 1,51,42
parent_id Filter groups who have these IDs above them in the group hierarchy query array false 1,51,42
state Filter groups by given states (comma-separated) query array false active,archived
page query Page false
sort Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. query array false -name,updated_at,-state
include Comma separated list of relationships to include. query array false parent,users
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Groups
401 Authentication Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Production Tasks

Retrieve a production task

Request: Retrieve a production task

curl -X GET https://api.COMPANY.brmbl.io/v1/production_tasks/12088 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_O7Ra6Cxk_AlsZ0n7R4MYCyNw6lBW7r96v" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "description": "pt-ze7DVhRX",
      "entry_mode": "MANUAL",
      "improvement_category": "rpa",
      "inserted_at": "2024-02-19T02:09:33Z",
      "name": "Customer Outreach",
      "state": "active",
      "updated_at": "2024-02-19T02:09:33Z"
    },
    "id": "12088",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/production_tasks/12088"
    },
    "relationships": {},
    "type": "production_tasks"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/production_tasks/12088"
  }
}

You can fetch the details of a single production task.

Request

GET /v1/production_tasks/{id}

Parameters

Parameter Description In Type Required Default Example
id Production task ID to retrieve. path integer true 233

Responses

Status Description Schema
200 ProductionTask
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

List all Production Tasks

Request: List all production tasks (filtered).

curl -X GET https://api.COMPANY.brmbl.io/v1/production_tasks?improvement_category=core \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_5YM9Rm0N_WVGIfX6spkrRMHnrIcnn1YVl" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "description": "pt-DhTtEFqY",
        "entry_mode": "MANUAL",
        "improvement_category": "core",
        "inserted_at": "2024-02-19T02:09:33Z",
        "name": "Lodge Claim",
        "state": "active",
        "updated_at": "2024-02-19T02:09:33Z"
      },
      "id": "12083",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/production_tasks/12083"
      },
      "relationships": {
        "process": {
          "data": {
            "id": "6145",
            "type": "process"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/process/6145",
            "self": "http://api.COMPANY.brmbl.io/v1/production_tasks/12083/relationships/process"
          }
        }
      },
      "type": "production_tasks"
    }
  ],
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/production_tasks?improvement_category=core"
  },
  "meta": {
    "pagination": {
      "page_number": 1,
      "page_size": 25,
      "total_entries": 1,
      "total_pages": 1
    }
  }
}

You can fetch a list of all production tasks.

Request

GET /v1/production_tasks

Parameters

Parameter Description In Type Required Default Example
group_id Filter the tasks owned by the given group(s). query array false 1, 2, 3
improvement_category Filter the tasks in given continuous improvement category(ies). query array false core,rpa
process_id Filter by Process(es) query array false 1,2,3
state Filter by the task status. query array false active,archived
page query Page false
sort Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. query array false -name,ideal_task_time
include Comma separated list of relationships to include. query array false process
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Production Tasks
401 Authentication Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Quality Scores

Create a Quality score

Request: Create a quality score

curl -X POST https://api.COMPANY.brmbl.io/v1/quality_scores \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_8FtJHeV3_X1AfnFox5z6FBBlusTRtb7Dy" \
-d @- << EOF

{
  "date": "2022-02-23",
  "note": null,
  "score": 0.95,
  "user_id": "39498"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:33Z",
      "note": null,
      "score": 0.95,
      "updated_at": "2024-02-19T02:09:33Z"
    },
    "id": "1688",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/1688"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "39498",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39498",
          "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/1688/relationships/user"
        }
      }
    },
    "type": "quality_scores"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/1688"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid format. Expected :date",
      "source": {
        "pointer": "/date"
      },
      "title": "Invalid value"
    }
  ]
}

You can create a quality score for a user, for a particular day.

Request

POST /v1/quality_scores

Responses

Status Description Schema
201 Quality Score Response
401 Authentication Error
404 Not Found Error
409 Conflict
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Retrieve a quality score

Request: Retrieve a quality score

curl -X GET https://api.COMPANY.brmbl.io/v1/quality_scores/1676 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_PUwceB0F_89yvc3XWL6StIMgoZUhI6R84" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2023-01-01",
      "inserted_at": "2024-02-19T02:09:32Z",
      "note": null,
      "score": 0.5,
      "updated_at": "2024-02-19T02:09:32Z"
    },
    "id": "1676",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/1676"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "39482",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39482",
          "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/1676/relationships/user"
        }
      }
    },
    "type": "quality_scores"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/1676"
  }
}

Response: 404 Not Found

{
  "errors": [
    {
      "code": "40401",
      "detail": "Could not find quality score with id: 1673",
      "status": "404",
      "title": "Resource Not Found"
    }
  ]
}

You can fetch the details of a single quality score.

Request

GET /v1/quality_scores/{id}

Parameters

Parameter Description In Type Required Default Example
id Quality score ID to retrieve. path integer true 233
include Comma separated list of relationships to include. query array false user
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Quality Score Response
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

List all quality scores

Request: List of quality scores (filtered by date)

curl -X GET https://api.COMPANY.brmbl.io/v1/quality_scores?date=2023-01-02&page[number]=1&page[size]=10&sort=score&fields[quality_scores]=score,date \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_0Ln0VnW9_0aZJkjrTOFwVLf1d4JM2G7rW" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "date": "2023-01-02",
        "score": 0.25
      },
      "id": "1673",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/1673"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "39479",
            "type": "users"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/users/39479",
            "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/1673/relationships/user"
          }
        }
      },
      "type": "quality_scores"
    },
    {
      "attributes": {
        "date": "2023-01-02",
        "score": 0.5
      },
      "id": "1674",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/1674"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "39480",
            "type": "users"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/users/39480",
            "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/1674/relationships/user"
          }
        }
      },
      "type": "quality_scores"
    }
  ],
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/quality_scores?date=2023-01-02&fields%5Bquality_scores%5D=score%2Cdate&page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=score"
  },
  "meta": {
    "pagination": {
      "page_number": 1,
      "page_size": 10,
      "total_entries": 2,
      "total_pages": 1
    }
  }
}

You can fetch a list of all quality scores.

Request

GET /v1/quality_scores

Parameters

Parameter Description In Type Required Default Example
date Filter results scored for this date query string false 2022-02-28
user_id Filter results with this Bramble user ID query integer false 12
group_id Filter scores for users in this Bramble group query integer false 2
production_task_id Filter results with this Bramble task ID query integer false 5
page query Page false
sort Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. query array false -date,-score
include Comma separated list of relationships to include. query array false user
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Quality Scores
401 Authentication Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Service Level Scores

Create a Service Level score

Request: Create a service level

curl -X POST https://api.COMPANY.brmbl.io/v1/service_levels \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_HqjYyNAb_wPnejifK9yXPz47nJSGhIo3l" \
-d @- << EOF

{
  "date": "2022-02-23",
  "note": null,
  "production_task_id": 12073,
  "score": 0.55
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:31Z",
      "note": null,
      "score": 0.55,
      "updated_at": "2024-02-19T02:09:31Z"
    },
    "id": "1309",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/service_levels/1309"
    },
    "relationships": {
      "production_task": {
        "data": {
          "id": "12073",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12073",
          "self": "http://api.COMPANY.brmbl.io/v1/service_levels/1309/relationships/production_task"
        }
      }
    },
    "type": "service_levels"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/service_levels/1309"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid format. Expected :date",
      "source": {
        "pointer": "/date"
      },
      "title": "Invalid value"
    }
  ]
}

Request: Several service levels can exist for the same date + production_task parameter

curl -X POST https://api.COMPANY.brmbl.io/v1/service_levels \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_9hFPWd1d_BLcyGPUVEGBCnd11OQSIEBqP" \
-d @- << EOF

{
  "date": "2022-02-23",
  "note": null,
  "production_task_id": 12076,
  "score": 0.55
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:31Z",
      "note": null,
      "score": 0.55,
      "updated_at": "2024-02-19T02:09:31Z"
    },
    "id": "1314",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/service_levels/1314"
    },
    "relationships": {
      "production_task": {
        "data": {
          "id": "12076",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12076",
          "self": "http://api.COMPANY.brmbl.io/v1/service_levels/1314/relationships/production_task"
        }
      }
    },
    "type": "service_levels"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/service_levels/1314"
  }
}

You can create a service level score for a task.

A service level ranks the SLA for a Production Task on a specific date.

Request

POST /v1/service_levels

Responses

Status Description Schema
201 Service Level Response
401 Authentication Error
404 Not Found Error
409 Conflict
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Retrieve a service level

Request: Retrieve a service level

curl -X GET https://api.COMPANY.brmbl.io/v1/service_levels/1298 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_s0oeUh6q_jfX1uYTV2ArpSUMWXtzm5OKL" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-02-19T02:09:31Z",
      "note": null,
      "score": 0.1,
      "updated_at": "2024-02-19T02:09:31Z"
    },
    "id": "1298",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/service_levels/1298"
    },
    "relationships": {
      "production_task": {
        "data": {
          "id": "12064",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12064",
          "self": "http://api.COMPANY.brmbl.io/v1/service_levels/1298/relationships/production_task"
        }
      }
    },
    "type": "service_levels"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/service_levels/1298"
  }
}

Response: 404 Not Found

{
  "errors": [
    {
      "code": "40401",
      "detail": "Could not find service level with id: 1295",
      "status": "404",
      "title": "Resource Not Found"
    }
  ]
}

You can fetch the details of a single service level score.

Request

GET /v1/service_levels/{id}

Parameters

Parameter Description In Type Required Default Example
id The ID of the Service level to fetch path integer true 233
include Comma separated list of relationships to include. query array false production_task
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Service Level Response
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

List all service levels

Request: List all service levels, filtered.

curl -X GET https://api.COMPANY.brmbl.io/v1/service_levels?date=2023-01-01,2023-01-02&page[number]=1&page[size]=100&sort=-score,date&fields[service_levels]=score \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_0ZeYDtmf_BziRtW98YvzfKeaKh9Gdu1Ih" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "score": 0.9
      },
      "id": "1296",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/service_levels/1296"
      },
      "relationships": {
        "production_task": {
          "data": {
            "id": "12063",
            "type": "production_tasks"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12063",
            "self": "http://api.COMPANY.brmbl.io/v1/service_levels/1296/relationships/production_task"
          }
        }
      },
      "type": "service_levels"
    },
    {
      "attributes": {
        "score": 0.5
      },
      "id": "1295",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/service_levels/1295"
      },
      "relationships": {
        "production_task": {
          "data": {
            "id": "12062",
            "type": "production_tasks"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12062",
            "self": "http://api.COMPANY.brmbl.io/v1/service_levels/1295/relationships/production_task"
          }
        }
      },
      "type": "service_levels"
    }
  ],
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/service_levels?date=2023-01-01%2C2023-01-02&fields%5Bservice_levels%5D=score&page%5Bnumber%5D=1&page%5Bsize%5D=100&sort=-score%2Cdate"
  },
  "meta": {
    "pagination": {
      "page_number": 1,
      "page_size": 100,
      "total_entries": 2,
      "total_pages": 1
    }
  }
}

You can fetch a list of all service level scores.

You can optionally filter the list by score date and production task.

You can also optionally request the page and page size to limit and paginate through the results.

Request

GET /v1/service_levels

Parameters

Parameter Description In Type Required Default Example
date Filter results scored for this date query array false 2022-02-28,2022-02-29
fields Comma separated list of fields to return. query object false
include Comma separated list of relationships to include. query array false production_task
page query Page false
production_task_id Filter results by task id query array false 12
sort Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. query array false -date,-score

Responses

Status Description Schema
200 Service Levels
401 Authentication Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Supporting Tasks

Retrieve a supporting task

Request: Retrieve a supporting task

curl -X GET https://api.COMPANY.brmbl.io/v1/supporting_tasks/8946 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_QCmCgZe0_QQCG69k0mEhurUvPmMI7fDJP" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "category": "train",
      "description": "CxjRjju0",
      "inserted_at": "2024-02-19T02:09:32Z",
      "name": "Compliance Training",
      "state": "active",
      "updated_at": "2024-02-19T02:09:32Z"
    },
    "id": "8946",
    "links": {
      "self": "http://www.example.com/v1/supporting_tasks/8946"
    },
    "relationships": {},
    "type": "supporting_tasks"
  },
  "included": [],
  "links": {
    "self": "http://www.example.com/v1/supporting_tasks/8946"
  }
}

You can fetch the details of a single supporting task.

Request

GET /v1/supporting_tasks/{id}

Parameters

Parameter Description In Type Required Default Example
id Supporting task ID to retrieve. path integer true 233

Responses

Status Description Schema
200 SupportingTask
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

List all Supporting Tasks

Request: List all supporting tasks (filtered).

curl -X GET https://api.COMPANY.brmbl.io/v1/supporting_tasks?state=active \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_CQk4zf7b_DzKL4q51psFDZSYLYxilDa9J" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "category": "train",
        "description": "sBfnzzSz",
        "inserted_at": "2024-02-19T02:09:32Z",
        "name": "Compliance Training",
        "state": "active",
        "updated_at": "2024-02-19T02:09:32Z"
      },
      "id": "8950",
      "links": {
        "self": "http://www.example.com/v1/supporting_tasks/8950"
      },
      "relationships": {},
      "type": "supporting_tasks"
    }
  ],
  "included": [],
  "links": {
    "self": "http://www.example.com/v1/supporting_tasks?state=active"
  },
  "meta": {
    "pagination": {
      "page_number": 1,
      "page_size": 25,
      "total_entries": 1,
      "total_pages": 1
    }
  }
}

You can fetch a list of all supporting tasks.

Request

GET /v1/supporting_tasks

Parameters

Parameter Description In Type Required Default Example
category Filter the tasks in given category(ies). query array false meeting,leadership
state Filter by the task status. query array false active,archived
page query Page false
sort Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. query array false -name,updated_at,-state
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Supporting Tasks
401 Authentication Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Task Input

Adjust an inventory balance

Request: Create a task input

curl -X POST https://api.COMPANY.brmbl.io/v1/task_inputs \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_4DpzV9Zc_SvKGSWnxItbmeLJOZOn55OvD" \
-d @- << EOF

{
  "adjustment_type": null,
  "date": "2022-02-23",
  "production_task_id": 12054,
  "volume": 1
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:30Z",
      "updated_at": "2024-02-19T02:09:30Z",
      "volume": 1
    },
    "id": "1174",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/task_inputs/1174"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "35469",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/35469",
          "self": "http://api.COMPANY.brmbl.io/v1/task_inputs/1174/relationships/group"
        }
      },
      "production_task": {
        "data": {
          "id": "12054",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12054",
          "self": "http://api.COMPANY.brmbl.io/v1/task_inputs/1174/relationships/production_task"
        }
      }
    },
    "type": "task_inputs"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/task_inputs/1174"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid format. Expected :date",
      "source": {
        "pointer": "/date"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 410 410 (no description)

{
  "errors": [
    {
      "detail": "The task_input we tried to create is ignored: \"The volume must not be 0\"",
      "source": {
        "pointer": ":volume"
      },
      "title": "Ignored"
    }
  ]
}

You can adjust an inventory balance by creating a Task Input.

A Task Input is used to manage the workload in a task queue. It represents incoming or queued work items from the source system. You can adjust the volume of work using this API. Negative volumes are allowed, allowing you to decrease the inventory balance for a task."

Request

POST /v1/task_inputs

Responses

Status Description Schema
201 Task Input
401 Authentication Error
404 Not Found Error
409 Conflict
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Retrieve a task input

Request: Retrieve a task input

curl -X GET https://api.COMPANY.brmbl.io/v1/task_inputs/1163 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_PV6A4dpM_mQAW8WJoNXxgTI3Ipia9iT1A" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-02-19T02:09:30Z",
      "updated_at": "2024-02-19T02:09:30Z",
      "volume": 10
    },
    "id": "1163",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/task_inputs/1163"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "35457",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/35457",
          "self": "http://api.COMPANY.brmbl.io/v1/task_inputs/1163/relationships/group"
        }
      },
      "production_task": {
        "data": {
          "id": "12045",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/12045",
          "self": "http://api.COMPANY.brmbl.io/v1/task_inputs/1163/relationships/production_task"
        }
      }
    },
    "type": "task_inputs"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/task_inputs/1163"
  }
}

Response: 404 Not Found

{
  "errors": [
    {
      "code": "40401",
      "detail": "Could not find task input with id: 1160",
      "status": "404",
      "title": "Resource Not Found"
    }
  ]
}

You can fetch the details of a single Task Input (AKA inventory adjustment).

Request

GET /v1/task_inputs/{id}

Parameters

Parameter Description In Type Required Default Example
id Task input ID path integer true 233
include Comma separated list of relationships to include. query array false production_task
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Task Input
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

List all task inputs

Request: List all inventory adjustments (filtered)

curl -X GET https://api.COMPANY.brmbl.io/v1/task_inputs?date=2020-01-02&page[number]=1&page[size]=2&sort=date&fields[task_inputs]=volume \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_CBhCY3oJ_ownZTT6C5vXXs9nhYrR2IblN" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "volume": 20
      },
      "id": "1160",
      "links": {
        "self": "http://www.example.com/v1/task_inputs/1160"
      },
      "relationships": {
        "group": {
          "data": {
            "id": "35455",
            "type": "groups"
          },
          "links": {
            "related": "http://www.example.com/v1/groups/35455",
            "self": "http://www.example.com/v1/task_inputs/1160/relationships/group"
          }
        },
        "production_task": {
          "data": {
            "id": "12043",
            "type": "production_tasks"
          },
          "links": {
            "related": "http://www.example.com/v1/production_tasks/12043",
            "self": "http://www.example.com/v1/task_inputs/1160/relationships/production_task"
          }
        }
      },
      "type": "task_inputs"
    },
    {
      "attributes": {
        "volume": 40
      },
      "id": "1161",
      "links": {
        "self": "http://www.example.com/v1/task_inputs/1161"
      },
      "relationships": {
        "group": {
          "data": {
            "id": "35455",
            "type": "groups"
          },
          "links": {
            "related": "http://www.example.com/v1/groups/35455",
            "self": "http://www.example.com/v1/task_inputs/1161/relationships/group"
          }
        },
        "production_task": {
          "data": {
            "id": "12044",
            "type": "production_tasks"
          },
          "links": {
            "related": "http://www.example.com/v1/production_tasks/12044",
            "self": "http://www.example.com/v1/task_inputs/1161/relationships/production_task"
          }
        }
      },
      "type": "task_inputs"
    }
  ],
  "included": [],
  "links": {
    "self": "http://www.example.com/v1/task_inputs?date=2020-01-02&fields%5Btask_inputs%5D=volume&page%5Bnumber%5D=1&page%5Bsize%5D=2&sort=date"
  },
  "meta": {
    "pagination": {
      "page_number": 1,
      "page_size": 2,
      "total_entries": 2,
      "total_pages": 1
    }
  }
}

You can fetch a list of all task inputs.

The list can be filtered by date, or production_task_id, or a combination of those.

The list is currently limited to the latest 50 adjustments.

Request

GET /v1/task_inputs

Parameters

Parameter Description In Type Required Default Example
date Filter inputs for this date query string false 2022-02-28
production_task_id Filter inputs for this task id query integer false 12
page query Page false
sort Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. query array false -date,-volume
include Comma separated list of relationships to include. query array false production_task
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Task Input
401 Authentication Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

UserPlanEntries

Retrieve a user plan entry.

Request: Returns a user plan entry

curl -X GET https://api.COMPANY.brmbl.io/v1/user_plan_entries/14875 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_SIGzXGgh_E8nf9Xp3oKs3UfdF7q9U6FXg" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2024-02-26",
      "inserted_at": "2024-02-19T02:09:29Z",
      "minutes": "450",
      "type": "base_time",
      "updated_at": "2024-02-19T02:09:29Z"
    },
    "id": "14875",
    "links": {
      "self": "http://company.brmbl.io/v1/user_plan_entries/14875"
    },
    "relationships": {},
    "type": "user_plan_entries"
  },
  "included": [],
  "links": {
    "self": "http://company.brmbl.io/v1/user_plan_entries/14875"
  }
}

Request: Returns a user plan entry

curl -X GET https://api.COMPANY.brmbl.io/v1/user_plan_entries/14859?include=user_plan \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_XJ81Iw60_22ANLoaY9RkHspoda20DkA6S" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2024-02-26",
      "inserted_at": "2024-02-19T02:09:29Z",
      "minutes": "450",
      "type": "base_time",
      "updated_at": "2024-02-19T02:09:29Z"
    },
    "id": "14859",
    "links": {
      "self": "http://company.brmbl.io/v1/user_plan_entries/14859"
    },
    "relationships": {
      "user_plan": {
        "data": {
          "id": "3230",
          "type": "user_plans"
        },
        "links": {
          "related": "http://company.brmbl.io/v1/user_plans/3230",
          "self": "http://company.brmbl.io/v1/user_plan_entries/14859/relationships/user_plan"
        }
      }
    },
    "type": "user_plan_entries"
  },
  "included": [
    {
      "attributes": {
        "contribution": 0.33,
        "from": "2024-02-26",
        "inserted_at": "2024-02-19T02:09:29Z",
        "until": "2024-03-03",
        "updated_at": "2024-02-19T02:09:29Z",
        "week_number": 9,
        "year": 2024
      },
      "id": "3230",
      "links": {
        "self": "http://company.brmbl.io/v1/user_plans/3230"
      },
      "relationships": {},
      "type": "user_plans"
    }
  ],
  "links": {
    "self": "http://company.brmbl.io/v1/user_plan_entries/14859"
  }
}

You can fetch the details of a single user plan entry.

Request

GET /v1/user_plan_entries/{id}

Parameters

Parameter Description In Type Required Default Example
id User plan entry ID to retrieve. path integer true 233
include Comma separated list of relationships to include. query array false users
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 User Plan Entries Response
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Upserts a user plan entry.

Request: Create a user plan supporting task entry

curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans/3228/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_wKGVOKtT_eLYUCf4eTEnU3jLp9a6asz6q" \
-d @- << EOF

{
  "date": "2022-02-23",
  "minutes": 450,
  "supporting_task_id": "8936",
  "type": "supporting_task",
  "user_id": "39293"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:29Z",
      "minutes": "450",
      "type": "supporting_task",
      "updated_at": "2024-02-19T02:09:29Z"
    },
    "id": "14856",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14856"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "35425",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/35425",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14856/relationships/group"
        }
      },
      "supporting_task": {
        "data": {
          "id": "8936",
          "type": "supporting_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/8936",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14856/relationships/supporting_task"
        }
      },
      "user": {
        "data": {
          "id": "39293",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39293",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14856/relationships/user"
        }
      },
      "user_plan": {
        "data": {
          "id": "3228",
          "type": "user_plans"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/user_plans/3228",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14856/relationships/user_plan"
        }
      }
    },
    "type": "user_plan_entries"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14856"
  }
}

Request: Update a user plan supporting task entry

curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans/3235/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_CcZx7BND_Zn2qflaKZk5Xid5Yh38jw2bO" \
-d @- << EOF

{
  "date": "2022-02-23",
  "minutes": 450,
  "supporting_task_id": "8938",
  "type": "supporting_task",
  "user_id": "39307"
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:29Z",
      "minutes": "900",
      "type": "supporting_task",
      "updated_at": "2024-02-19T02:09:30Z"
    },
    "id": "14871",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14871"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "35439",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/35439",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14871/relationships/group"
        }
      },
      "supporting_task": {
        "data": {
          "id": "8938",
          "type": "supporting_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/8938",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14871/relationships/supporting_task"
        }
      },
      "user": {
        "data": {
          "id": "39307",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39307",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14871/relationships/user"
        }
      },
      "user_plan": {
        "data": {
          "id": "3235",
          "type": "user_plans"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/user_plans/3235",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14871/relationships/user_plan"
        }
      }
    },
    "type": "user_plan_entries"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14871"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Failed to cast value to one of: no schemas validate",
      "source": {
        "pointer": "/"
      },
      "title": "Invalid value"
    }
  ]
}

Request: Create a user plan base time entry

curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans/3238/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_oXX4NRIE_bmCN5qul19DbQOSwOLBt8L10" \
-d @- << EOF

{
  "date": "2022-02-23",
  "minutes": 450,
  "type": "base_time",
  "user_id": "39313"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:29Z",
      "minutes": "450",
      "type": "base_time",
      "updated_at": "2024-02-19T02:09:29Z"
    },
    "id": "14874",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14874"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "35445",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/35445",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14874/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "39313",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39313",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14874/relationships/user"
        }
      },
      "user_plan": {
        "data": {
          "id": "3238",
          "type": "user_plans"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/user_plans/3238",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14874/relationships/user_plan"
        }
      }
    },
    "type": "user_plan_entries"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14874"
  }
}

Request: Update a user plan supporting task entry

curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans/3229/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_CbFtB2f5_P2jhaYsdWx90Wc9no2RXlWd8" \
-d @- << EOF

{
  "date": "2022-02-23",
  "minutes": 450,
  "type": "base_time",
  "user_id": "39295"
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-02-19T02:09:29Z",
      "minutes": "900",
      "type": "base_time",
      "updated_at": "2024-02-19T02:09:30Z"
    },
    "id": "14857",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14857"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "35427",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/35427",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14857/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "39295",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39295",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14857/relationships/user"
        }
      },
      "user_plan": {
        "data": {
          "id": "3229",
          "type": "user_plans"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/user_plans/3229",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14857/relationships/user_plan"
        }
      }
    },
    "type": "user_plan_entries"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/14857"
  }
}

Tries to create a user's planned supporting task or base time entry. If an existing entry exists, it will update the existing one instead

Request

PUT /v1/user_plans/{id}/user_plan_entry

Parameters

Parameter Description In Type Required Default Example
x-lineage-data Log optional lineage data (a Base 64 encoded JSON object) with which to build a history. header string false

Responses

Status Description Schema
200 User Plan Entries Response
201 User Plan Entries Response
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

UserPlans

Creates a user's plan for the week

Request: Creates user's plan for a week

curl -X POST https://api.COMPANY.brmbl.io/v1/user_plans \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_iPWn2BIv_EGvvl2jfXMa71WkPvcgHSI5P" \
-d @- << EOF

{
  "contribution": null,
  "user_id": "39378",
  "week_number": 1,
  "year": 2024
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "contribution": 0.5,
      "from": "2024-01-01",
      "inserted_at": "2024-02-19T02:09:31Z",
      "until": "2024-01-07",
      "updated_at": "2024-02-19T02:09:31Z",
      "week_number": 1,
      "year": 2024
    },
    "id": "3243",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3243"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "35497",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/35497",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3243/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "39378",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39378",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3243/relationships/user"
        }
      }
    },
    "type": "user_plans"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3243"
  }
}

Request: Creates user's plan with contribution

curl -X POST https://api.COMPANY.brmbl.io/v1/user_plans \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_1w23GvnT_M7Guo8CE2wbz95gishjR18Eo" \
-d @- << EOF

{
  "contribution": 0.6,
  "user_id": "39380",
  "week_number": 1,
  "year": 2024
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "contribution": 0.5,
      "from": "2024-01-01",
      "inserted_at": "2024-02-19T02:09:31Z",
      "until": "2024-01-07",
      "updated_at": "2024-02-19T02:09:31Z",
      "week_number": 1,
      "year": 2024
    },
    "id": "3244",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3244"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "35499",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/35499",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3244/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "39380",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39380",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3244/relationships/user"
        }
      }
    },
    "type": "user_plans"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3244"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid number. Got: string",
      "source": {
        "pointer": "/week_number"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid number. Got: string",
      "source": {
        "pointer": "/year"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 409 Conflict

{
  "errors": [
    {
      "detail": "Plan is already defined for this time period",
      "source": {
        "pointer": ":user_id"
      },
      "title": "Conflict"
    }
  ]
}

Creates user's plan for a week.

Request

POST /v1/user_plans

Parameters

Parameter Description In Type Required Default Example
x-lineage-data Log optional lineage data (a Base 64 encoded JSON object) with which to build a history. header string false

Responses

Status Description Schema
201 User Plans Response
401 Authentication Error
404 Not Found Error
409 Conflict
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Gets or creates a user's plan.

Request: Creates a user's plan for a week

curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_nXYu4Kdt_xDNBg0rUNN3nQTVm42gW9eEl" \
-d @- << EOF

{
  "contribution": null,
  "user_id": "39396",
  "week_number": 1,
  "year": 2024
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "contribution": 0.5,
      "from": "2024-01-01",
      "inserted_at": "2024-02-19T02:09:31Z",
      "until": "2024-01-07",
      "updated_at": "2024-02-19T02:09:31Z",
      "week_number": 1,
      "year": 2024
    },
    "id": "3250",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3250"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "35515",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/35515",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3250/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "39396",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39396",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3250/relationships/user"
        }
      }
    },
    "type": "user_plans"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3250"
  }
}

Request: Creates user's plan with contribution

curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_pJhkSYNC_VQcEBq2JFqKqV1GlF2mckPKj" \
-d @- << EOF

{
  "contribution": 0.6,
  "user_id": "39382",
  "week_number": 1,
  "year": 2024
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "contribution": 0.5,
      "from": "2024-01-01",
      "inserted_at": "2024-02-19T02:09:31Z",
      "until": "2024-01-07",
      "updated_at": "2024-02-19T02:09:31Z",
      "week_number": 1,
      "year": 2024
    },
    "id": "3245",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3245"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "35501",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/35501",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3245/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "39382",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39382",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3245/relationships/user"
        }
      }
    },
    "type": "user_plans"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3245"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid number. Got: string",
      "source": {
        "pointer": "/week_number"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid number. Got: string",
      "source": {
        "pointer": "/year"
      },
      "title": "Invalid value"
    }
  ]
}

Request: Gets existing user plan from parameter

curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_ixo8zHdO_Vj5MptVKWO4t282sJLUgAgIo" \
-d @- << EOF

{
  "contribution": null,
  "user_id": "39394",
  "week_number": 1,
  "year": 2024
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "contribution": 0.5,
      "from": "2024-01-01",
      "inserted_at": "2024-02-19T02:09:31Z",
      "until": "2024-01-07",
      "updated_at": "2024-02-19T02:09:31Z",
      "week_number": 1,
      "year": 2024
    },
    "id": "3249",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3249"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "35513",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/35513",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3249/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "39394",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/39394",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3249/relationships/user"
        }
      }
    },
    "type": "user_plans"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plans/3249"
  }
}

Tries to get an existing plan, and will create if no existing plan is found instead.

Request

PUT /v1/user_plans

Parameters

Parameter Description In Type Required Default Example
x-lineage-data Log optional lineage data (a Base 64 encoded JSON object) with which to build a history. header string false

Responses

Status Description Schema
201 User Plans Response
401 Authentication Error
404 Not Found Error
409 Conflict
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Users

List all users

Request: Returns a list of users, filtered

curl -X GET https://api.COMPANY.brmbl.io/v1/users?email=bob@foo.com,frank@foo.com&sort=-full_name&page[number]=1&page[size]=3 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_yeDqaWgP_8FMWVzJ6QDdW4a53IXG4yFIB" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "account_role": null,
        "email": "frank@foo.com",
        "full_name": "Frank Furter",
        "inserted_at": "2024-02-19T02:09:30Z",
        "preferred_first_name": "Frank",
        "state": "invited",
        "team_role": "team_owner",
        "timezone": "America/Los_Angeles",
        "updated_at": "2024-02-19T02:09:30Z"
      },
      "id": "39366",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/users/39366"
      },
      "relationships": {
        "group": {
          "data": {
            "id": "35487",
            "type": "groups"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/groups/35487",
            "self": "http://api.COMPANY.brmbl.io/v1/users/39366/relationships/group"
          }
        }
      },
      "type": "users"
    },
    {
      "attributes": {
        "account_role": "account_owner",
        "email": "bob@foo.com",
        "full_name": "Bob Owner",
        "inserted_at": "2024-02-19T02:09:30Z",
        "preferred_first_name": "Bob",
        "state": "invited",
        "team_role": null,
        "timezone": "Etc/UTC",
        "updated_at": "2024-02-19T02:09:30Z"
      },
      "id": "39365",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/users/39365"
      },
      "relationships": {
        "group": {
          "data": {
            "id": "35486",
            "type": "groups"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/groups/35486",
            "self": "http://api.COMPANY.brmbl.io/v1/users/39365/relationships/group"
          }
        }
      },
      "type": "users"
    }
  ],
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/users?email=bob%40foo.com%2Cfrank%40foo.com&page%5Bnumber%5D=1&page%5Bsize%5D=3&sort=-full_name"
  },
  "meta": {
    "pagination": {
      "page_number": 1,
      "page_size": 3,
      "total_entries": 2,
      "total_pages": 1
    }
  }
}

Returns a list of users.

Request

GET /v1/users

Parameters

Parameter Description In Type Required Default Example
email Filter by email(s) query array false example@brmbl.io,foo@bar.com
group_id Filter users in these groups, including groups above these in hierarchy query array false 1,51,42
page query Page false
sort Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. query array false -email,updated_at
include Comma separated list of relationships to include. query array false group
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 Task Input
401 Authentication Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Fetch a user by ID

Request: Successful request returns the user

curl -X GET https://api.COMPANY.brmbl.io/v1/users/39369 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_rEpNQyP2_E9loOsZsieiNABwxPXzUaTs0" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "account_role": null,
      "email": "myles.schaefer@dickinson.net",
      "full_name": "Jane Doe",
      "inserted_at": "2024-02-19T02:09:30Z",
      "preferred_first_name": "Something",
      "state": "invited",
      "team_role": "team_owner",
      "timezone": "Africa/Abidjan",
      "updated_at": "2024-02-19T02:09:30Z"
    },
    "id": "39369",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/users/39369"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "35489",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/35489",
          "self": "http://api.COMPANY.brmbl.io/v1/users/39369/relationships/group"
        }
      }
    },
    "type": "users"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/users/39369"
  }
}

Response: 404 Not Found

{
  "errors": [
    {
      "code": "40401",
      "detail": "Could not find user with id: 39456",
      "status": "404",
      "title": "Resource Not Found"
    }
  ]
}

Returns the user identified by an internal Bramble ID.

Request

GET /v1/users/{id}

Parameters

Parameter Description In Type Required Default Example
id User ID path integer true 233
include Comma separated list of relationships to include. query array false group
fields Comma separated list of fields to return. query object false

Responses

Status Description Schema
200 User
401 Authentication Error
404 Not Found Error
410 Ignored
422 Unprocessible Entity
500 Internal Server Error

Models

ServiceLevel

Service Level

{
  "attributes": {
    "date": "2022-02-23",
    "inserted_at": "1970-01-01T00:00:00.000000Z",
    "note": null,
    "score": 0.55,
    "updated_at": "2023-01-01T00:00:00.000000Z"
  },
  "id": "281",
  "links": {
    "self": "https://api.COMPANY.brmbl.io/v1/service_levels/4"
  },
  "relationships": {
    "production_task": {
      "data": {
        "id": "2",
        "type": "production_tasks"
      },
      "links": {
        "related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
        "self": "https://api.COMPANY.brmbl.io/v1/service_levels/4/relationships/production_task"
      }
    }
  },
  "type": "service_levels"
}
Property Description Type Format Required
id The id of the Service Level. string true
type always "service_levels" string true
attributes.date Which day was this score given? string date false
attributes.inserted_at The timestamp of when this resource was created. string date-time false
attributes.note An optional note. string false
attributes.score A percentage (as a floating point number between 0 and 1) rating a production task's service level for this date. number float false
attributes.updated_at The last updated timestamp of this resource. string date-time false
relationships.production_task.data.id The unique identifier string true
relationships.production_task.data.type string true
relationships.production_task.links.related Link for the relationship itself string uri false
relationships.production_task.links.self Link for the relationship itself string uri false

UserPlanEntry

User plan entry is a way to record how someone plans to spend their day.

Property Description Type Format Required
id The unique ID of the user plan entry. string true
type value is always "user_plan_entries" string true
attributes.date When was this planned to happen? string date false
attributes.inserted_at Insertion time-stamp. string date-time false
attributes.minutes The amount of time spent. Usually a positive integer, but negative values are permitted. integer int32 false
attributes.type Is it a base time or a supporting task? string false
attributes.updated_at Update time-stamp. string date-time false
relationships.group.data.id The unique identifier string true
relationships.group.data.type string true
relationships.group.links.related Link for the relationship itself string uri false
relationships.group.links.self Link for the relationship itself string uri false
relationships.supporting_task.data.id The unique identifier string true
relationships.supporting_task.data.type string true
relationships.supporting_task.links.related Link for the relationship itself string uri false
relationships.supporting_task.links.self Link for the relationship itself string uri false
relationships.user.data.id The unique identifier string true
relationships.user.data.type string true
relationships.user.links.related Link for the relationship itself string uri false
relationships.user.links.self Link for the relationship itself string uri false
relationships.user_plan.data.id The unique identifier string true
relationships.user_plan.data.type string true
relationships.user_plan.links.related Link for the relationship itself string uri false
relationships.user_plan.links.self Link for the relationship itself string uri false

TaskInput

Task inputs record the volume of incoming work for a given task. They act as a log of adjustments to the balance of a task backlog, recording either new work arriving in a task queue, or reconciliation events that correct the inventory balance. Negative volumes are permitted.

{
  "attributes": {
    "date": "2022-02-23",
    "inserted_at": "1970-01-01T00:00:00.000000Z",
    "updated_at": "2023-01-01T00:00:00.000000Z",
    "volume": 1
  },
  "id": "281",
  "links": {
    "self": "https://api.COMPANY.brmbl.io/v1/task_inputs/4"
  },
  "relationships": {
    "group": {
      "data": {
        "id": "3",
        "type": "groups"
      },
      "links": {
        "related": "https://api.COMPANY.brmbl.io/v1/groups/3",
        "self": "https://api.COMPANY.brmbl.io/v1/task_inputs/4/relationships/group"
      }
    },
    "production_task": {
      "data": {
        "id": "2",
        "type": "production_tasks"
      },
      "links": {
        "related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
        "self": "https://api.COMPANY.brmbl.io/v1/task_inputs/4/relationships/production_task"
      }
    }
  },
  "type": "task_inputs"
}
Property Description Type Format Required
id The id of the Task Input. string true
type always "task_inputs" string true
attributes.date When did this input event happen? string date false
attributes.volume The amount to adjust the task inventory by. Usually a positive integer, but negative values are permitted. integer int32 false
relationships.group.data.id The unique identifier string true
relationships.group.data.type string true
relationships.group.links.related Link for the relationship itself string uri false
relationships.group.links.self Link for the relationship itself string uri false
relationships.production_task.data.id The unique identifier string true
relationships.production_task.data.type string true
relationships.production_task.links.related Link for the relationship itself string uri false
relationships.production_task.links.self Link for the relationship itself string uri false

Group

Groups are teams of users in Bramble. Groups are arranged in a tree hierarchy (using parent_group_id).

{
  "attributes": {
    "inserted_at": "1970-01-01T00:00:00.000000Z",
    "name": "North America",
    "state": "active",
    "updated_at": "2023-01-01T00:00:00.000000Z"
  },
  "id": "54",
  "relationships": {
    "parent": {
      "data": {
        "id": "2",
        "type": "groups"
      },
      "links": {
        "self": "https://api.COMPANY.brmbl.io/v1/groups/4/relationships/parent"
      }
    }
  },
  "type": "groups"
}
Property Description Type Format Required
id The id of the group. string true
type value is always "groups" string true
attributes.inserted_at The timestamp of when this resource was created. string date-time false
attributes.name The name of the group string false
attributes.state The current status string false
attributes.updated_at The last updated timestamp of this resource. string date-time false
relationships.parent.data.id The unique identifier string true
relationships.parent.data.type string true
relationships.parent.links.self Link for the relationship itself string uri false

AgentQueueMetrics

Contact center data for one agent on one day by queue.

{}
Property Description Type Format Required
after_call_work_seconds Total amount of time the agent spent completing after-call work. integer false
conversations Count of Automatic Call Distributor (ACD) conversations. integer true
date The date of the day that this data is for. string date true
handle_seconds Total time of all conversations, including talk, hold and after call work time integer false
hold_seconds Total time that conversations were placed on hold. integer false
inserted_at Insertion time-stamp. string date-time false
production_task_id Bramble production task ID of the queue that this data is for. integer true
quality_score Call quality percentage, expressed as a fraction between 0 and 1. number float false
talk_seconds Total Time spent actively interacting. integer false
user_id Bramble user ID of the agent that this data is for. integer true

QueueDailyMetrics

Contact center data for one queue on one day.

{}
Property Description Type Format Required
after_call_work_seconds Total amount of time the agent spent completing after-call work. integer false
conversations Count of Automatic Call Distributor (ACD) conversations. integer true
date The date of the day that this data is for. string date true
handle_seconds Total time of all conversations, including talk, hold and after call work time integer false
hold_seconds Total time that conversations were placed on hold. integer false
inserted_at Insertion time-stamp. string date-time false
production_task_id Bramble production task ID of the queue that this data is for. integer true
service_level Service level percentage, expressed as a fraction between 0 and 1. number float false
talk_seconds Total Time spent actively interacting. integer false

User

A user in Bramble, often an Individual Contributor (IC) or Manager. Can also be other system users like Account Owners/Admins. Non-owners/admins are associated with one Group.

{
  "attributes": {
    "email": "jane-doe12@brmbl.io",
    "full_name": "Jane Doe",
    "inserted_at": "1970-01-01T00:00:00.000000Z",
    "preferred_first_name": "Jane",
    "state": "active",
    "team_role": "team_contributor",
    "timezone": "Africa/Abidjan",
    "type": "users",
    "updated_at": "2023-01-01T00:00:00.000000Z"
  },
  "id": "23",
  "relationships": {
    "parent": {
      "data": {
        "id": "2",
        "type": "groups"
      },
      "links": {
        "self": "https://api.COMPANY.brmbl.io/v1/users/4/relationships/group"
      }
    }
  },
  "type": "users"
}
Property Description Type Format Required
id The id of the user. string true
type value is always "users" string true
attributes.account_role Account-level role string false
attributes.email A user's email. This is a unique value and can be used to find a user via the api/users endpoint. string false
attributes.full_name The user's first and last name. string false
attributes.inserted_at The timestamp of when this resource was created. string date-time false
attributes.preferred_first_name The user's preferred name. string false
attributes.state The current status string false
attributes.team_role Team-level role string false
attributes.timezone The user's preferred timezone. string false
attributes.type value is always "users" string false
attributes.updated_at The last updated timestamp of this resource. string date-time false
relationships.group.data.id The unique identifier string true
relationships.group.data.type string true
relationships.group.links.self Link for the relationship itself string uri false

CostCategory

Cost Categories provide additional insight and delineation of organizational production costs i.e how much it's costing to complete work for Category 'X' versus 'Y'.

{
  "attributes": {
    "description": "sample description",
    "inserted_at": "1970-01-01T00:00:00.000000Z",
    "name": "Auto",
    "state": "active",
    "updated_at": "2023-01-01T00:00:00.000000Z"
  },
  "id": "54",
  "type": "cost_categories"
}
Property Description Type Format Required
id The id of the cost category. string true
type value is always "cost_categories" string true
attributes.description The description of the cost category string false
attributes.inserted_at The timestamp of when this resource was created. string date-time false
attributes.name The name of the cost category string false
attributes.state The current state string false
attributes.updated_at The last updated timestamp of this resource. string date-time false

QualityScore

The overall score of the quality of a user's work on the given date. If your organization has a quality framework in place, your Front-line managers are usually responsible for measuring quality scores for IC's on a regular basis. This API allows Bramble to receive these quality scores from an external system.

{
  "attributes": {
    "date": "2022-02-23",
    "inserted_at": "1970-01-01T00:00:00.000000Z",
    "note": null,
    "score": 0.95,
    "updated_at": "2023-01-01T00:00:00.000000Z"
  },
  "id": "281",
  "links": {
    "self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4"
  },
  "relationships": {
    "user": {
      "data": {
        "id": "2",
        "type": "users"
      },
      "links": {
        "related": "https://api.COMPANY.brmbl.io/v1/users/2",
        "self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4/relationships/user"
      }
    }
  },
  "type": "quality_scores"
}
Property Description Type Format Required
id The id of the Quality Score. string true
type always "quality_scores" string true
attributes.date The date for which this score was given string date false
attributes.note An optional note. string false
attributes.score A percentage (as a floating point number between 0 and 1) rating the persons performance on the given day number float false
relationships.agent_queue_metrics.data.id The unique identifier string true
relationships.agent_queue_metrics.data.type string true
relationships.agent_queue_metrics.links.related Link for the relationship itself string uri false
relationships.agent_queue_metrics.links.self Link for the relationship itself string uri false
relationships.production_task.data.id The unique identifier string true
relationships.production_task.data.type string true
relationships.production_task.links.related Link for the relationship itself string uri false
relationships.production_task.links.self Link for the relationship itself string uri false
relationships.user.data.id The unique identifier string true
relationships.user.data.type string true
relationships.user.links.related Link for the relationship itself string uri false
relationships.user.links.self Link for the relationship itself string uri false

Pagination

Pagination metadata

{
  "count": 2,
  "current_page": 1,
  "per_page": 2,
  "total": 50,
  "total_pages": 25
}
Property Description Type Format Required
count Number of records in the current page integer int64 false
current_page Current page number integer int64 false
per_page Number of records per page integer int64 false
total Total number of records integer int64 false
total_pages Total number of pages integer int64 false

Page

{
  "number": 2,
  "size": 100
}
Property Description Type Format Required
number Page number to retrieve integer int32 false
size Number of items per page integer int32 false

CheckinItem

Checkin items are a way to record how a user spends their time during the course of the day.

Property Description Type Format Required
id The id of the checkin item. string true
type value is always "checkin_items" string true
attributes.date When did this checkin item event happen? string date false
attributes.inserted_at The timestamp of when this resource was created. string date-time false
attributes.minutes The amount of time spent on a task. Usually a positive integer, but negative values are permitted. integer int32 false
attributes.updated_at The last updated timestamp of this resource. string date-time false
attributes.volume The number of times the task is completed. Usually a positive integer, but negative values are permitted. integer int32 false
relationships.checkin.data.id The unique identifier string true
relationships.checkin.data.type string true
relationships.checkin.links.related Link for the relationship itself string uri false
relationships.checkin.links.self Link for the relationship itself string uri false
relationships.cost_category.data.id The unique identifier string true
relationships.cost_category.data.type string true
relationships.cost_category.links.related Link for the relationship itself string uri false
relationships.cost_category.links.self Link for the relationship itself string uri false
relationships.production_task.data.id The unique identifier string true
relationships.production_task.data.type string true
relationships.production_task.links.related Link for the relationship itself string uri false
relationships.production_task.links.self Link for the relationship itself string uri false
relationships.supporting_task.data.id The unique identifier string true
relationships.supporting_task.data.type string true
relationships.supporting_task.links.related Link for the relationship itself string uri false
relationships.supporting_task.links.self Link for the relationship itself string uri false
relationships.user.data.id The unique identifier string true
relationships.user.data.type string true
relationships.user.links.related Link for the relationship itself string uri false
relationships.user.links.self Link for the relationship itself string uri false

SupportingTask

Supporting Tasks are regular (often planned) business activities that may only indirectly contribute to business outcomes.

{
  "category": "meeting",
  "id": "32",
  "inserted_at": "2023-06-14T06:00:47Z",
  "name": "Test supporting task",
  "state": "active",
  "type": "supporting_tasks",
  "updated_at": "2023-06-14T06:00:47Z"
}
Property Description Type Format Required
category supporting task's category string false
id Bramble internal supporting task id string false
inserted_at The timestamp of when this resource was created. string date-time false
name The supporting task's name. string false
state The supporting task's state. string false
type always "supporting_tasks" string false
updated_at The last updated timestamp of this resource. string date-time false

AgentDailyMetrics

Contact center summary data for one agent on one day.

{}
Property Description Type Format Required
after_call_work_seconds Total amount of time the agent spent completing after-call work. integer false
aux_seconds The total amount of time the agent spent in non-ACD work e.g. breaks, training, meetings etc integer false
available_seconds The total time that the agent was available to take ACD calls integer false
conversations Count of Automatic Call Distributor (ACD) conversations. integer true
date The date of the day that this data is for. string date true
handle_seconds Total time of all conversations, including talk, hold and after call work time integer false
hold_seconds Total time that conversations were placed on hold. integer false
idle_seconds Total idle time. integer false
inserted_at Insertion time-stamp. string date-time false
staffed_seconds The total amount of time the agent spent logged into the ACD system. integer false
talk_seconds Total Time spent actively interacting. integer false
user_id Bramble user ID of the agent that this data is for. integer true

Meta

Metadata about the response

{
  "pagination": {
    "count": 2,
    "current_page": 1,
    "per_page": 2,
    "total": 50,
    "total_pages": 25
  }
}
Property Description Type Format Required
pagination.count Number of records in the current page integer int64 false
pagination.current_page Current page number integer int64 false
pagination.per_page Number of records per page integer int64 false
pagination.total Total number of records integer int64 false
pagination.total_pages Total number of pages integer int64 false

Checkin

This is a way to record a user checking-in for a day, and also allows user to set which type of work location they did.

{
  "attributes": {
    "date": "2022-02-23",
    "inserted_at": "1970-01-01T00:00:00.000000Z",
    "updated_at": "2023-01-01T00:00:00.000000Z",
    "work_location": "distributed"
  },
  "id": "23",
  "links": {
    "self": "https://api.COMPANY.brmbl.io/v1/users/4"
  },
  "relationships": {
    "user": {
      "data": {
        "id": "2",
        "type": "users"
      },
      "links": {
        "related": "https://api.COMPANY.brmbl.io/v1/users/2",
        "self": "https://api.COMPANY.brmbl.io/v1/checkins/4/relationships/user"
      }
    }
  },
  "type": "checkins"
}
Property Description Type Format Required
id The id of the checkin. string true
type value is always "checkins" string true
attributes.date Which day was this checkin created? string date false
attributes.inserted_at The timestamp of when this resource was created. string date-time false
attributes.updated_at The last updated timestamp of this resource. string date-time false
attributes.work_location where the work is done. string false
relationships.user.data.id The unique identifier string true
relationships.user.data.type string true
relationships.user.links.related Link for the relationship itself string uri false
relationships.user.links.self Link for the relationship itself string uri false

ProductionTask

A Production Task represents the primary, measurable, unit of work in a Process

{
  "entry_mode": "MANUAL",
  "group_id": 1,
  "id": 34,
  "improvement_category": "rpa",
  "inserted_at": "2023-06-14T06:00:47Z",
  "name": "Test Task",
  "process_id": 1,
  "state": "active",
  "type": "production_tasks",
  "updated_at": "2023-06-14T06:00:47Z"
}
Property Description Type Format Required
entry_mode The production task's entry mode. string false
group_id Bramble group identifier. integer false
id Bramble internal production task id integer false
improvement_category production task's CI(continous improvement) category string false
inserted_at The timestamp of when this resource was created. string date-time false
name The production task's name. string false
process_id Bramble process identifier. integer false
state The production task's state. string false
type always "production_tasks" string false
updated_at The last updated timestamp of this resource. string date-time false

UserPlan

This is a way to record a user plan for a week, and also allows user to set how much contribution they plan on doing.

{
  "attributes": {
    "contribution": 0.95,
    "from": "2023-12-18",
    "inserted_at": "1970-01-01T00:00:00.000000Z",
    "until": "2023-12-24",
    "updated_at": "2023-01-01T00:00:00.000000Z"
  },
  "id": "23",
  "links": {
    "self": "https://api.COMPANY.brmbl.io/v1/user_plans/4"
  },
  "relationships": {
    "group": {
      "data": {
        "id": "2",
        "type": "groups"
      },
      "links": {
        "related": "https://api.COMPANY.brmbl.io/v1/groups/2",
        "self": "https://api.COMPANY.brmbl.io/v1/user_plans/4/relationships/group"
      }
    },
    "user": {
      "data": {
        "id": "2",
        "type": "users"
      },
      "links": {
        "related": "https://api.COMPANY.brmbl.io/v1/users/2",
        "self": "https://api.COMPANY.brmbl.io/v1/user_plans/4/relationships/user"
      }
    }
  },
  "type": "user_plans"
}
Property Description Type Format Required
id The id of the user plan. string true
type value is always "user_plans" string true
attributes.contribution A percentage (as a floating point number between 0 and 1) rating the persons contribution on the given week number float false
attributes.from The first date covered by the user plan string date false
attributes.inserted_at Insertion time-stamp. string date-time false
attributes.until The last date covered by the user plan string date false
attributes.updated_at Update time-stamp. string date-time false
attributes.week_number The week number according to ISO-8601 standard number int32 false
attributes.year The year of the where number int32 false
relationships.group.data.id The unique identifier string true
relationships.group.data.type string true
relationships.group.links.related Link for the relationship itself string uri false
relationships.group.links.self Link for the relationship itself string uri false
relationships.user.data.id The unique identifier string true
relationships.user.data.type string true
relationships.user.links.related Link for the relationship itself string uri false
relationships.user.links.self Link for the relationship itself string uri false

FrictionType

Friction is defined as any obstacle, process, task or system that does not add value in the eyes of the customer.

{
  "category": "downtime",
  "id": "32",
  "inserted_at": "2023-08-01T06:00:47Z",
  "name": "Computer issues",
  "state": "active",
  "type": "friction_types",
  "updated_at": "2023-08-01T06:00:47Z"
}
Property Description Type Format Required
category Friction category string false
id Bramble internal friction type id string false
inserted_at The timestamp of when this resource was created. string date-time false
name The friction type's name. string false
state The friction type's state. string false
type always "friction_types" string false
updated_at The last updated timestamp of this resource. string date-time false

Error Models

AuthenticationError

{
  "errors": [
    {
      "detail": "Please check your client id and secret key, and make sure your credentials are active.",
      "source": {
        "pointer": "header: authorization => id, mac"
      },
      "title": "Authentication Failed",
      "type": "AUTHENTICATION_FAILED"
    }
  ]
}
Property Description Type Format Required
errors array(any) true

NotFoundError

{
  "errors": [
    {
      "detail": "The requested resource does not exist.",
      "status": 404,
      "title": "Resource Not Found"
    }
  ]
}
Property Description Type Format Required
errors array(any) true

IgnoreError

{
  "errors": [
    {
      "detail": "The identity we found is set to be ignored",
      "source": {
        "pointer": "/source_id/value"
      },
      "title": "Ignored"
    }
  ]
}
Property Description Type Format Required
errors array(any) true

ConflictError

{
  "errors": [
    {
      "detail": "Must be unique: production_task_id + date",
      "source": {
        "pointer": "/production_task_id"
      },
      "title": "Validation Failed"
    }
  ]
}
Property Description Type Format Required
errors array(any) true

InternalServerError

{
  "errors": [
    {
      "detail": "Server Error: we could not complete your request",
      "title": "Unexpected Server Error",
      "type": "UNEXPECTED_ERROR"
    }
  ]
}
Property Description Type Format Required
errors array(any) true

Request Models

AgentDailyMetricsParams

Input parameters for Agent Daily Metrics.

{
  "conversations": 3,
  "date": "2012-12-13",
  "user_id": 3
}
Property Description Type Format Required
after_call_work_seconds Total amount of time the agent spent completing after-call work. integer false
aux_seconds The total amount of time the agent spent in non-ACD work e.g. breaks, training, meetings etc integer false
available_seconds The total time that the agent was available to take ACD calls integer false
conversations Count of Automatic Call Distributor (ACD) conversations. integer true
date The date of the day that this data is for. string date true
handle_seconds Total time of all conversations, including talk, hold and after call work time integer false
hold_seconds Total time that conversations were placed on hold. integer false
idle_seconds Total idle time. integer false
staffed_seconds The total amount of time the agent spent logged into the ACD system. integer false
talk_seconds Total Time spent actively interacting. integer false
user_id Bramble user ID of the agent that this data is for. integer true

UserPlanParams

Input parameters for User Plan.

{
  "user_id": "3",
  "week_number": 1,
  "year": 2024
}
Property Description Type Format Required
contribution A percentage (as a floating point number between 0 and 1) rating the persons contribution on the given week number float false
user_id The id of the user. string true
week_number The week number according to ISO-8601 standard number int32 true
year The year of the where number int32 true

AgentQueueMetricsParams

Input parameters for Agent Queue Metrics.

{
  "conversations": 3,
  "date": "2012-12-13",
  "quality_score": 0.8,
  "user_id": 3
}
Property Description Type Format Required
after_call_work_seconds Total amount of time the agent spent completing after-call work. integer false
conversations Count of Automatic Call Distributor (ACD) conversations. integer true
date The date of the day that this data is for. string date true
handle_seconds Total time of all conversations, including talk, hold and after call work time integer false
hold_seconds Total time that conversations were placed on hold. integer false
production_task_id Bramble production task ID of the queue that this data is for. integer false
quality_score Call quality percentage, expressed as a fraction between 0 and 1. number float false
talk_seconds Total Time spent actively interacting. integer false
user_id Bramble user ID of the agent that this data is for. integer true

UserPlanSupportingTaskEntryParams

Input parameters for User Plan Supporting Task Entries

{
  "date": "2022-02-23",
  "minutes": 450,
  "supporting_task_id": "432",
  "type": "supporting_task",
  "user_id": "234"
}
Property Description Type Format Required
date When was this planned to happen? string date true
minutes The amount of time spent. Usually a positive integer, but negative values are permitted. integer int32 true
supporting_task_id Bramble internal supporting task id string true
type value is always true "supporting_task" string true
user_id The id of the user. string true

ServiceLevelParams

Input params for a Service Level

{
  "date": "2022-02-23",
  "production_task_id": "34",
  "score": 0.55
}
Property Description Type Format Required
date Which day was this score given? string date true
note An optional note. string false
production_task_id Bramble internal production task id integer true
score A percentage (as a floating point number between 0 and 1) rating a production task's service level for this date. number float true

UserPlanEntryParams

Input parameters for User Plan Entries, can be either a base time or supporting task parameters

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/UserPlanBaseTimeEntryParams"
    },
    {
      "$ref": "#/components/schemas/UserPlanSupportingTaskEntryParams"
    }
  ]
}

QueueDailyMetricsParams

Input parameters for Queue Daily Metrics.

{
  "conversations": 3,
  "date": "2012-12-13",
  "production_task_id": 3,
  "service_level": 0.6
}
Property Description Type Format Required
after_call_work_seconds Total amount of time the agent spent completing after-call work. integer false
conversations Count of Automatic Call Distributor (ACD) conversations. integer true
date The date of the day that this data is for. string date true
handle_seconds Total time of all conversations, including talk, hold and after call work time integer false
hold_seconds Total time that conversations were placed on hold. integer false
production_task_id Bramble production task ID of the queue that this data is for. integer true
service_level Service level percentage, expressed as a fraction between 0 and 1. number float false
talk_seconds Total Time spent actively interacting. integer false

CheckinItemsParams

Input parameters for Checkin Items, can be either a production task or supporting task parameters

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/ProductionTaskCheckinItemParams"
    },
    {
      "$ref": "#/components/schemas/SupportingTaskCheckinItemParams"
    }
  ]
}

UserPlanBaseTimeEntryParams

Input parameters for User Plan Supporting Task Entries

{
  "date": "2022-02-23",
  "minutes": 450,
  "type": "base_time",
  "user_id": "234"
}
Property Description Type Format Required
date When was this planned to happen? string date true
minutes The amount of time spent. Usually a positive integer, but negative values are permitted. integer int32 true
type value is always true "base_time" string true
user_id The id of the user. string true

SupportingTaskCheckinItemParams

Input parameters for Supporting Task Entries

{
  "checkin_id": "1",
  "date": "2022-02-23",
  "minutes": 450,
  "supporting_task_id": 432,
  "user_id": "234"
}
Property Description Type Format Required
checkin_id The id of the checkin. string true
date When did this checkin item event happen? string date true
minutes The amount of time spent on a task. Usually a positive integer, but negative values are permitted. integer int32 true
supporting_task_id Bramble internal supporting task id string true
user_id The id of the user. string true

CheckinParams

Input parameters for Checkin

{
  "date": "2022-02-23",
  "user_id": 432
}
Property Description Type Format Required
date Which day was this checkin created? string date true
user_id The id of the user. string true
work_location where the work is done. string false

TaskInputParams

Input parameters for Task Inputs

{
  "date": "2022-02-23",
  "production_task_id": "432",
  "volume": 1
}
Property Description Type Format Required
adjustment_type adjustment_type is either "additive" or "overwrite". string false
date When did this input event happen? string date true
production_task_id Bramble internal production task id integer true
volume The amount to adjust the task inventory by. Usually a positive integer, but negative values are permitted. integer int32 true

QualityScoreParams

Input params for Quality Score

{
  "date": "2022-02-23",
  "score": 0.95,
  "user_id": "234"
}
Property Description Type Format Required
date The date for which this score was given string date true
note An optional note. string false
score A percentage (as a floating point number between 0 and 1) rating the persons performance on the given day number float true
user_id The id of the user. string true

ProductionTaskCheckinItemParams

Input parameters for Production Task Entries

{
  "checkin_id": "1",
  "date": "2022-02-23",
  "production_task_id": 432,
  "user_id": "234",
  "volume": 1
}
Property Description Type Format Required
checkin_id The id of the checkin. string true
cost_category_id The id of the cost category. string false
date When did this checkin item event happen? string date true
production_task_id Bramble internal production task id integer true
user_id The id of the user. string true
volume The number of times the task is completed. Usually a positive integer, but negative values are permitted. integer int32 true

Response Models

CostCategoryResponse

A Bramble Cost Category.

{
  "data": {
    "attributes": {
      "description": "sample description",
      "inserted_at": "1970-01-01T00:00:00.000000Z",
      "name": "Auto",
      "state": "active",
      "updated_at": "2023-01-01T00:00:00.000000Z"
    },
    "id": "54",
    "type": "cost_categories"
  }
}
Property Description Type Format Required
data CostCategory false

UserPlanSupportingTaskEntryResponse

User Plan Supporting Task Entry Response

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "1970-01-01T00:00:00.000000Z",
      "minutes": 450,
      "type": "supporting_task",
      "updated_at": "2023-01-01T00:00:00.000000Z"
    },
    "id": "54",
    "links": {
      "self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "1",
          "type": "groups"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/group"
        }
      },
      "supporting_task": {
        "data": {
          "id": "2",
          "type": "supporting_tasks"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/supporting_task"
        }
      },
      "user": {
        "data": {
          "id": "1",
          "type": "users"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/user"
        }
      },
      "user_plan": {
        "data": {
          "id": "1",
          "type": "user_plans"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/user_plan"
        }
      }
    },
    "type": "user_plan_entries"
  },
  "included": [],
  "links": {
    "self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4"
  }
}
Property Description Type Format Required
data UserPlanEntry true
included Included resource objects (compound documents) array(any) false
links.self Link for the relationship itself string uri false

QueueDailyMetricsResponse

Queue Metrics Response.

{
  "data": {
    "attributes": {
      "after_call_work_seconds": null,
      "conversations": 3,
      "date": "2012-12-13",
      "handle_seconds": null,
      "hold_seconds": null,
      "queue_id": 25473,
      "talk_seconds": null
    },
    "id": "123",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/123"
    },
    "relationships": {
      "service_level": {
        "data": {
          "id": "456",
          "type": "service_levels"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/service_levels/456",
          "self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/123/relationships/service_level"
        }
      }
    },
    "type": "queue_daily_metrics"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/123"
  }
}
Property Description Type Format Required
data.queue_metrics QueueDailyMetrics false

SupportingTasksResponse

Supporting Task List Response

{
  "data": [
    {
      "category": "meeting",
      "id": "32",
      "inserted_at": "2023-06-14T06:00:47Z",
      "name": "Test supporting task",
      "state": "active",
      "type": "supporting_tasks",
      "updated_at": "2023-06-14T06:00:47Z"
    }
  ],
  "meta": {
    "pagination": {
      "count": 2,
      "current_page": 1,
      "per_page": 2,
      "total": 50,
      "total_pages": 25
    }
  }
}
Property Description Type Format Required
data Generic Data Wrapper array(any) false
meta.pagination.count Number of records in the current page integer int64 false
meta.pagination.current_page Current page number integer int64 false
meta.pagination.per_page Number of records per page integer int64 false
meta.pagination.total Total number of records integer int64 false
meta.pagination.total_pages Total number of pages integer int64 false

JsonErrorResponse

Property Description Type Format Required
errors array(any) true

CheckinItemsResponse

Checkin Items List Response

{
  "data": [
    {
      "attributes": {
        "date": "2020-04-20",
        "inserted_at": "1970-01-01T00:00:00.000000Z",
        "minutes": 0,
        "updated_at": "1970-01-01T00:00:00.000000Z",
        "volume": 0
      },
      "id": "",
      "relationships": {
        "checkin": {
          "data": {
            "id": "123",
            "type": "checkins"
          },
          "links": {
            "related": "https://api.COMPANY.brmbl.io/checkins/123",
            "self": "https://api.COMPANY.brmbl.io/checkin_items/1/relationships/checkin"
          }
        },
        "cost_category": {
          "data": {
            "id": "123",
            "type": "cost_categories"
          },
          "links": {
            "related": "https://api.COMPANY.brmbl.io/cost_categories/123",
            "self": "https://api.COMPANY.brmbl.io/checkin_items/1/relationships/cost_category"
          }
        },
        "production_task": {
          "data": {
            "id": "123",
            "type": "production_tasks"
          },
          "links": {
            "related": "https://api.COMPANY.brmbl.io/production_tasks/123",
            "self": "https://api.COMPANY.brmbl.io/checkin_items/1/relationships/production_task"
          }
        },
        "supporting_task": {
          "data": {
            "id": "123",
            "type": "supporting_tasks"
          },
          "links": {
            "related": "https://api.COMPANY.brmbl.io/supporting_tasks/123",
            "self": "https://api.COMPANY.brmbl.io/checkin_items/1/relationships/supporting_task"
          }
        },
        "user": {
          "data": {
            "id": "123",
            "type": "users"
          },
          "links": {
            "related": "https://api.COMPANY.brmbl.io/users/123",
            "self": "https://api.COMPANY.brmbl.io/checkin_items/1/relationships/user"
          }
        }
      },
      "type": "checkin_items"
    }
  ],
  "meta": {
    "pagination": {
      "count": 2,
      "current_page": 1,
      "per_page": 2,
      "total": 50,
      "total_pages": 25
    }
  }
}
Property Description Type Format Required
data Generic Data Wrapper array(any) false
meta.pagination.count Number of records in the current page integer int64 false
meta.pagination.current_page Current page number integer int64 false
meta.pagination.per_page Number of records per page integer int64 false
meta.pagination.total Total number of records integer int64 false
meta.pagination.total_pages Total number of pages integer int64 false

GroupsResponse

Group List Response

{
  "data": [
    {
      "attributes": {
        "inserted_at": "1970-01-01T00:00:00.000000Z",
        "name": "North America",
        "state": "active",
        "updated_at": "2023-01-01T00:00:00.000000Z"
      },
      "id": "54",
      "relationships": {
        "parent": {
          "data": {
            "id": "2",
            "type": "groups"
          },
          "links": {
            "self": "https://api.COMPANY.brmbl.io/v1/groups/4/relationships/parent"
          }
        }
      },
      "type": "groups"
    }
  ],
  "meta": {
    "pagination": {
      "count": 2,
      "current_page": 1,
      "per_page": 2,
      "total": 50,
      "total_pages": 25
    }
  }
}
Property Description Type Format Required
data Generic Data Wrapper array(any) false
meta.pagination.count Number of records in the current page integer int64 false
meta.pagination.current_page Current page number integer int64 false
meta.pagination.per_page Number of records per page integer int64 false
meta.pagination.total Total number of records integer int64 false
meta.pagination.total_pages Total number of pages integer int64 false

SupportingTaskCheckinItemResponse

Supporting Task Item Response

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "1970-01-01T00:00:00.000000Z",
      "minutes": 450,
      "updated_at": "2023-01-01T00:00:00.000000Z",
      "volume": null
    },
    "id": "54",
    "links": {
      "self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "1",
          "type": "checkins"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/checkin"
        }
      },
      "supporting_task": {
        "data": {
          "id": "2",
          "type": "supporting_tasks"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/supporting_task"
        }
      },
      "user": {
        "data": {
          "id": "1",
          "type": "users"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4"
  }
}
Property Description Type Format Required
data CheckinItem true
included Included resource objects (compound documents) array(any) false
links.self Link for the relationship itself string uri false

UserResponse

User Response

{
  "data": {
    "attributes": {
      "email": "jane-doe12@brmbl.io",
      "full_name": "Jane Doe",
      "inserted_at": "1970-01-01T00:00:00.000000Z",
      "preferred_first_name": "Jane",
      "state": "active",
      "team_role": "team_contributor",
      "timezone": "Africa/Abidjan",
      "type": "users",
      "updated_at": "2023-01-01T00:00:00.000000Z"
    },
    "id": "23",
    "relationships": {
      "parent": {
        "data": {
          "id": "2",
          "type": "groups"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/users/4/relationships/group"
        }
      }
    },
    "type": "users"
  }
}
Property Description Type Format Required
data User false

UserPlanEntryResponse

Can either be a planned base time or supporting task entry response

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/UserPlanBaseTimeEntryResponse"
    },
    {
      "$ref": "#/components/schemas/UserPlanSupportingTaskEntryResponse"
    }
  ]
}

UsersResponse

User List Response

{
  "data": [
    {
      "attributes": {
        "email": "jane-doe12@brmbl.io",
        "full_name": "Jane Doe",
        "inserted_at": "1970-01-01T00:00:00.000000Z",
        "preferred_first_name": "Jane",
        "state": "active",
        "team_role": "team_contributor",
        "timezone": "Africa/Abidjan",
        "type": "users",
        "updated_at": "2023-01-01T00:00:00.000000Z"
      },
      "id": "23",
      "relationships": {
        "parent": {
          "data": {
            "id": "2",
            "type": "groups"
          },
          "links": {
            "self": "https://api.COMPANY.brmbl.io/v1/users/4/relationships/group"
          }
        }
      },
      "type": "users"
    }
  ]
}
Property Description Type Format Required
data Generic Data Wrapper array(any) false

FrictionTypeResponse

Friction Type Response

{
  "data": {
    "category": "downtime",
    "id": "32",
    "inserted_at": "2023-08-01T06:00:47Z",
    "name": "Computer issues",
    "state": "active",
    "type": "friction_types",
    "updated_at": "2023-08-01T06:00:47Z"
  }
}
Property Description Type Format Required
data FrictionType false

ProductionTaskResponse

Production Task Response

{
  "data": {
    "attributes": {
      "entry_mode": "MANUAL",
      "improvement_category": "rpa",
      "inserted_at": "2023-06-14T06:00:47Z",
      "name": "Test Task",
      "state": "active",
      "updated_at": "2023-06-14T06:00:47Z"
    },
    "id": "14150",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/production_tasks/14150"
    },
    "relationships": {},
    "type": "production_tasks"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/production_tasks/14150"
  }
}
Property Description Type Format Required
data ProductionTask false

TaskInputsResponse

Task Input List Response

{
  "data": [
    {
      "attributes": {
        "date": "2022-02-23",
        "inserted_at": "1970-01-01T00:00:00.000000Z",
        "updated_at": "2023-01-01T00:00:00.000000Z",
        "volume": 1
      },
      "id": "281",
      "links": {
        "self": "https://api.COMPANY.brmbl.io/v1/task_inputs/4"
      },
      "relationships": {
        "group": {
          "data": {
            "id": "3",
            "type": "groups"
          },
          "links": {
            "related": "https://api.COMPANY.brmbl.io/v1/groups/3",
            "self": "https://api.COMPANY.brmbl.io/v1/task_inputs/4/relationships/group"
          }
        },
        "production_task": {
          "data": {
            "id": "2",
            "type": "production_tasks"
          },
          "links": {
            "related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
            "self": "https://api.COMPANY.brmbl.io/v1/task_inputs/4/relationships/production_task"
          }
        }
      },
      "type": "task_inputs"
    }
  ],
  "meta": {
    "pagination": {
      "count": 2,
      "current_page": 1,
      "per_page": 2,
      "total": 50,
      "total_pages": 25
    }
  }
}
Property Description Type Format Required
data Generic Data Wrapper array(any) false
meta.pagination.count Number of records in the current page integer int64 false
meta.pagination.current_page Current page number integer int64 false
meta.pagination.per_page Number of records per page integer int64 false
meta.pagination.total Total number of records integer int64 false
meta.pagination.total_pages Total number of pages integer int64 false

ServiceLevelsResponse

Service Level List Response

{
  "data": [
    {
      "attributes": {
        "date": "2022-02-23",
        "inserted_at": "1970-01-01T00:00:00.000000Z",
        "note": null,
        "score": 0.55,
        "updated_at": "2023-01-01T00:00:00.000000Z"
      },
      "id": "281",
      "links": {
        "self": "https://api.COMPANY.brmbl.io/v1/service_levels/4"
      },
      "relationships": {
        "production_task": {
          "data": {
            "id": "2",
            "type": "production_tasks"
          },
          "links": {
            "related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
            "self": "https://api.COMPANY.brmbl.io/v1/service_levels/4/relationships/production_task"
          }
        }
      },
      "type": "service_levels"
    }
  ],
  "meta": {
    "pagination": {
      "count": 2,
      "current_page": 1,
      "per_page": 2,
      "total": 50,
      "total_pages": 25
    }
  }
}
Property Description Type Format Required
data Generic Data Wrapper array(any) false
meta.pagination.count Number of records in the current page integer int64 false
meta.pagination.current_page Current page number integer int64 false
meta.pagination.per_page Number of records per page integer int64 false
meta.pagination.total Total number of records integer int64 false
meta.pagination.total_pages Total number of pages integer int64 false

GroupResponse

A Bramble Group.

{
  "data": {
    "attributes": {
      "inserted_at": "1970-01-01T00:00:00.000000Z",
      "name": "North America",
      "state": "active",
      "updated_at": "2023-01-01T00:00:00.000000Z"
    },
    "id": "54",
    "relationships": {
      "parent": {
        "data": {
          "id": "2",
          "type": "groups"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/groups/4/relationships/parent"
        }
      }
    },
    "type": "groups"
  }
}
Property Description Type Format Required
data Group false

CostCategoriesResponse

Cost Categories List Response

{
  "data": [
    {
      "attributes": {
        "description": "sample description",
        "inserted_at": "1970-01-01T00:00:00.000000Z",
        "name": "Auto",
        "state": "active",
        "updated_at": "2023-01-01T00:00:00.000000Z"
      },
      "id": "54",
      "type": "cost_categories"
    }
  ],
  "meta": {
    "pagination": {
      "count": 2,
      "current_page": 1,
      "per_page": 2,
      "total": 50,
      "total_pages": 25
    }
  }
}
Property Description Type Format Required
data Generic Data Wrapper array(any) false
meta.pagination.count Number of records in the current page integer int64 false
meta.pagination.current_page Current page number integer int64 false
meta.pagination.per_page Number of records per page integer int64 false
meta.pagination.total Total number of records integer int64 false
meta.pagination.total_pages Total number of pages integer int64 false

ProductionTaskCheckinItemResponse

Production Task Entry Response

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "1970-01-01T00:00:00.000000Z",
      "minutes": 60,
      "updated_at": "2023-01-01T00:00:00.000000Z",
      "volume": 1
    },
    "id": "54",
    "links": {
      "self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "1",
          "type": "checkins"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/checkin"
        }
      },
      "cost_category": {
        "data": {
          "id": "1",
          "type": "cost_categories"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/cost_category"
        }
      },
      "production_task": {
        "data": {
          "id": "2",
          "type": "production_tasks"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "1",
          "type": "users"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4"
  }
}
Property Description Type Format Required
data CheckinItem true
included Included resource objects (compound documents) array(any) false
links.self Link for the relationship itself string uri false

UserPlanResponse

User Plan Response.

{
  "data": {
    "attributes": {
      "contribution": 0.95,
      "from": "2023-12-18",
      "inserted_at": "1970-01-01T00:00:00.000000Z",
      "until": "2023-12-24",
      "updated_at": "2023-01-01T00:00:00.000000Z"
    },
    "id": "23",
    "links": {
      "self": "https://api.COMPANY.brmbl.io/v1/user_plans/4"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "2",
          "type": "groups"
        },
        "links": {
          "related": "https://api.COMPANY.brmbl.io/v1/groups/2",
          "self": "https://api.COMPANY.brmbl.io/v1/user_plans/4/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "2",
          "type": "users"
        },
        "links": {
          "related": "https://api.COMPANY.brmbl.io/v1/users/2",
          "self": "https://api.COMPANY.brmbl.io/v1/user_plans/4/relationships/user"
        }
      }
    },
    "type": "user_plans"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plans/1055"
  }
}
Property Description Type Format Required
data.user_plans UserPlan false

ServiceLevelResponse

Service Level Response

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "1970-01-01T00:00:00.000000Z",
      "note": null,
      "score": 0.55,
      "updated_at": "2023-01-01T00:00:00.000000Z"
    },
    "id": "281",
    "links": {
      "self": "https://api.COMPANY.brmbl.io/v1/service_levels/4"
    },
    "relationships": {
      "production_task": {
        "data": {
          "id": "2",
          "type": "production_tasks"
        },
        "links": {
          "related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
          "self": "https://api.COMPANY.brmbl.io/v1/service_levels/4/relationships/production_task"
        }
      }
    },
    "type": "service_levels"
  },
  "included": [],
  "links": {
    "self": "https://api.COMPANY.brmbl.io/v1/service_levels/4"
  }
}
Property Description Type Format Required
data ServiceLevel true
included Included resource objects (compound documents) array(any) false
links.self Link for the relationship itself string uri false

TaskInputResponse

Task Input Response

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "1970-01-01T00:00:00.000000Z",
      "updated_at": "2023-01-01T00:00:00.000000Z",
      "volume": 1
    },
    "id": "281",
    "links": {
      "self": "https://api.COMPANY.brmbl.io/v1/task_inputs/4"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "3",
          "type": "groups"
        },
        "links": {
          "related": "https://api.COMPANY.brmbl.io/v1/groups/3",
          "self": "https://api.COMPANY.brmbl.io/v1/task_inputs/4/relationships/group"
        }
      },
      "production_task": {
        "data": {
          "id": "2",
          "type": "production_tasks"
        },
        "links": {
          "related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
          "self": "https://api.COMPANY.brmbl.io/v1/task_inputs/4/relationships/production_task"
        }
      }
    },
    "type": "task_inputs"
  },
  "included": [],
  "links": {
    "self": "https://api.COMPANY.brmbl.io/v1/task_inputs/4"
  }
}
Property Description Type Format Required
data TaskInput true
included Included resource objects (compound documents) array(any) false
links.self Link for the relationship itself string uri false

QualityScoresResponse

Quality Score List Response

{
  "data": [
    {
      "attributes": {
        "date": "2022-02-23",
        "inserted_at": "1970-01-01T00:00:00.000000Z",
        "note": null,
        "score": 0.95,
        "updated_at": "2023-01-01T00:00:00.000000Z"
      },
      "id": "281",
      "links": {
        "self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "2",
            "type": "users"
          },
          "links": {
            "related": "https://api.COMPANY.brmbl.io/v1/users/2",
            "self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4/relationships/user"
          }
        }
      },
      "type": "quality_scores"
    }
  ],
  "meta": {
    "pagination": {
      "count": 2,
      "current_page": 1,
      "per_page": 2,
      "total": 50,
      "total_pages": 25
    }
  }
}
Property Description Type Format Required
data Generic Data Wrapper array(any) false
meta.pagination.count Number of records in the current page integer int64 false
meta.pagination.current_page Current page number integer int64 false
meta.pagination.per_page Number of records per page integer int64 false
meta.pagination.total Total number of records integer int64 false
meta.pagination.total_pages Total number of pages integer int64 false

FrictionTypesResponse

Friction Type List Response

{
  "data": [
    {
      "category": "downtime",
      "id": "32",
      "inserted_at": "2023-08-01T06:00:47Z",
      "name": "Computer issues",
      "state": "active",
      "type": "friction_types",
      "updated_at": "2023-08-01T06:00:47Z"
    }
  ],
  "meta": {
    "pagination": {
      "count": 2,
      "current_page": 1,
      "per_page": 2,
      "total": 50,
      "total_pages": 25
    }
  }
}
Property Description Type Format Required
data Generic Data Wrapper array(any) false
meta.pagination.count Number of records in the current page integer int64 false
meta.pagination.current_page Current page number integer int64 false
meta.pagination.per_page Number of records per page integer int64 false
meta.pagination.total Total number of records integer int64 false
meta.pagination.total_pages Total number of pages integer int64 false

ProductionTasksResponse

Production Task List Response

{
  "data": [
    {
      "entry_mode": "MANUAL",
      "group_id": 1,
      "id": 34,
      "improvement_category": "rpa",
      "inserted_at": "2023-06-14T06:00:47Z",
      "name": "Test Task",
      "process_id": 1,
      "state": "active",
      "type": "production_tasks",
      "updated_at": "2023-06-14T06:00:47Z"
    }
  ],
  "meta": {
    "pagination": {
      "count": 2,
      "current_page": 1,
      "per_page": 2,
      "total": 50,
      "total_pages": 25
    }
  }
}
Property Description Type Format Required
data Generic Data Wrapper array(any) false
meta.pagination.count Number of records in the current page integer int64 false
meta.pagination.current_page Current page number integer int64 false
meta.pagination.per_page Number of records per page integer int64 false
meta.pagination.total Total number of records integer int64 false
meta.pagination.total_pages Total number of pages integer int64 false

AgentQueueMetricsResponse

Agent Queue Metrics Response.

{
  "data": {
    "attributes": {
      "after_call_work_seconds": null,
      "conversations": 3,
      "date": "2012-12-13",
      "entry_id": 104181,
      "handle_seconds": null,
      "hold_seconds": null,
      "production_task_id": 25473,
      "talk_seconds": null,
      "user_id": 1669
    },
    "id": "1055",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1055"
    },
    "relationships": {
      "checkin_item": {
        "data": {
          "id": "107190",
          "type": "checkin_items"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkin_items/107190",
          "self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1132/relationships/checkin_item"
        }
      },
      "quality_score": {
        "data": {
          "id": "711",
          "type": "quality_scores"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/quality_scores/711",
          "self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1132/relationships/quality_score"
        }
      }
    },
    "type": "agent_queue_metrics"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1055"
  }
}
Property Description Type Format Required
data.agent_queue_metrics AgentQueueMetrics false

CheckinItemResponse

Can either be a Production Task or Supporting Task Item response

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/ProductionTaskCheckinItemResponse"
    },
    {
      "$ref": "#/components/schemas/SupportingTaskCheckinItemResponse"
    }
  ]
}

CheckinResponse

Checkin Response

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "1970-01-01T00:00:00.000000Z",
      "updated_at": "2023-01-01T00:00:00.000000Z",
      "work_location": "distributed"
    },
    "id": "23",
    "links": {
      "self": "https://api.COMPANY.brmbl.io/v1/users/4"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "2",
          "type": "users"
        },
        "links": {
          "related": "https://api.COMPANY.brmbl.io/v1/users/2",
          "self": "https://api.COMPANY.brmbl.io/v1/checkins/4/relationships/user"
        }
      }
    },
    "type": "checkins"
  },
  "included": [],
  "links": {
    "self": "https://api.COMPANY.brmbl.io/v1/checkins/4"
  }
}
Property Description Type Format Required
data Checkin true
included Included resource objects (compound documents) array(any) false
links.self Link for the relationship itself string uri false

UserPlanBaseTimeEntryResponse

User Plan Base Time Entry Response

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "1970-01-01T00:00:00.000000Z",
      "minutes": 450,
      "type": "base_time",
      "updated_at": "2023-01-01T00:00:00.000000Z"
    },
    "id": "54",
    "links": {
      "self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "1",
          "type": "groups"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "1",
          "type": "users"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/user"
        }
      },
      "user_plan": {
        "data": {
          "id": "1",
          "type": "user_plans"
        },
        "links": {
          "self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/user_plan"
        }
      }
    },
    "type": "user_plan_entries"
  },
  "included": [],
  "links": {
    "self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4"
  }
}
Property Description Type Format Required
data UserPlanEntry true
included Included resource objects (compound documents) array(any) false
links.self Link for the relationship itself string uri false

SupportingTaskResponse

Supporting Task Response

{
  "data": {
    "category": "meeting",
    "id": "32",
    "inserted_at": "2023-06-14T06:00:47Z",
    "name": "Test supporting task",
    "state": "active",
    "type": "supporting_tasks",
    "updated_at": "2023-06-14T06:00:47Z"
  }
}
Property Description Type Format Required
data SupportingTask false

AgentDailyMetricsResponse

Agent Daily Metrics Response.

{
  "data": {
    "attributes": {
      "after_call_work_seconds": null,
      "aux_seconds": null,
      "available_seconds": null,
      "conversations": 3,
      "date": "2012-12-13",
      "handle_seconds": null,
      "hold_seconds": null,
      "idle_seconds": null,
      "staffed_seconds": null,
      "talk_seconds": null,
      "user_id": 123
    },
    "id": "755",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/755"
    },
    "relationships": {},
    "type": "agent_daily_metrics"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/755"
  }
}
Property Description Type Format Required
data.agent_daily_metrics AgentDailyMetrics false

QualityScoreResponse

A User's Quality Score.

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "1970-01-01T00:00:00.000000Z",
      "note": null,
      "score": 0.95,
      "updated_at": "2023-01-01T00:00:00.000000Z"
    },
    "id": "281",
    "links": {
      "self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "2",
          "type": "users"
        },
        "links": {
          "related": "https://api.COMPANY.brmbl.io/v1/users/2",
          "self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4/relationships/user"
        }
      }
    },
    "type": "quality_scores"
  },
  "included": [],
  "links": {
    "self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4"
  }
}
Property Description Type Format Required
data QualityScore true
included Included resource objects (compound documents) array(any) false
links.self Link for the relationship itself string uri false