Details
This is how we keep track of APIs and Endoints success and billing. We need to understand bothe the clients useage, and thier users usage.
Keep count of all read, writes, etc. provide a usage report. Use logs or logs should use this so we are not doing the same work twice.
Allow third party devs to integrate with this endpoint so they can track usage of thier endpoints. Devs can use this endoint for thier own personal use even if they do not publish thier API on BackBone, should they be listed on the BackBone marketplace, all useage data is shared with BackBone for billing.
Task Chat LaunchThis document is not meant to outline how to use the API endpoints, rather how to build it. We outline what it's capabilities should be, once you have built them, you can create documentation on how to utilize them on the APIs tab.
- Status & Details
- Research
- User Stories, Flows & Personas
- Features & Functions
- Data
Description
Add a detailed description
Status
These details are only updated with each release, for more acurate updates and keeping track of progress, see the task in GitHub.
| Doc Status | Product Status | Last Update | Version | Release | Phase |
|---|---|---|---|---|---|
| In Progress | Up Next | 04.03.2024 | 0.01 | Internal | Alpha |
Team
| Product Owner | Lead | Member #1 | Member #2 |
|---|---|---|---|
| Mendy | Esti | Nir | - |
Reminders
- Keep code lean and clear
- follow the outlined arcetecture
- write commetes in your code
- update the staus in the docs and in GitHub
- try not to recreate functions we alredy have, rather update exsiting functions to support your needs
- Be sure to follow the release guidelines
- Update Documentation
- keep API docs up to date each time you update or add endpoints
Links & Resources
Research
Features
Below is a list of features that will be utilized in order to deliver the best account features and functionalities. The details bellow are not comprehensive feature details but rather, describe how the features will be utilized within the account, for further details, please see the individual feature documentation.
-
[Filter]
-
[By Date]
Allow the selection of dates from until or last 7 days, last 30 days, etc.
-
[By Location]
allow filtering by region, coutry or city
the user data can provide many ways to filter like age, gender, income/spend, etc
-
[by project]
this may not be applicable in all cases as the lient may be viewing usage with a project however when view general account usage offer a per project filter as well as when viewing from system/internal
-
[by client]
this in only relevent for system accounts or agency accounts should we develop that in the future.
-
-
[Report]
should usage seem suspisus allow for a report option
-
[auto report]
automaticly detect suspius usage and generate a report
- [limites] allow the slient to set a total limit or per endpoint, per user, per IP, per project, etc. this is diferent from a budget limit within billing, while both serve a similar purpose, here we limit read, edit, write, there we only focus on monetary budgets.