docs: Add docs on pricing and API requests. Improve real-time docs #4566
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
rolodato
force-pushed
the
docs/api-usage
branch
from
7a37f1d to
ff9f3e6
Compare
rolodato
changed the title
docs/docs/pricing/index.mdx
Outdated
|
|
||
| ## What counts as an API request? | ||
|
|
||
| Any operation that calls Flagsmith's API to retrieve information about the current state of flags counts as 1 billable |
There was a problem hiding this comment.
Hmm... this isn't completely true. We should also include something about identifying an identity and/or updating an identity's traits.
There was a problem hiding this comment.
Identifying an identity still returns the current state of flags - it's the current state of flags as seen by a specific user.
Updating an identity's traits also returns the current state of flags for the identity that is being updated.
I tried to make this as generic as possible while not overwhelming with technical details, considering the audience for this document includes people who have not used Flagsmith at all.
There was a problem hiding this comment.
I also tried to make this explicit in the example below:
The device calls Flagsmith to update this user's traits and receives their latest flags in return (1 API request).
There was a problem hiding this comment.
I think we can solve any ambiguity here with a minor change to the wording:
| Any operation that calls Flagsmith's API to retrieve information about the current state of flags counts as 1 billable | |
| Any operation that calls Flagsmith's API to retrieve information about the current state of flags and/or persist an identity or their traits counts as 1 billable |
There was a problem hiding this comment.
I think having this level of technical detail in the first sentence does more harm than good. We don't need to introduce the concepts of identity or trait at this point - I've specifically avoided using the word "identity" as a Flagsmith concept in this doc to make it accessible for a wider audience, especially less-technical decision makers who don't care about these details.
In a separate PR, I could add a dedicated section with details on what actual endpoints are billed, things like /flags, /identities, /environment-document etc to detail the actual specifics.
There was a problem hiding this comment.
Another way to word this that is technically more accurate and doesn't add complexity could be:
| Any operation that calls Flagsmith's API to retrieve information about the current state of flags counts as 1 billable | |
| Any operation that calls Flagsmith's API and retrieves information about the current state of flags counts as 1 billable |
There was a problem hiding this comment.
Yep, good with me, apart from one minor typo: persist -> persists
Now with Visuals™
https://docs-git-docs-api-usage-flagsmith.vercel.app/pricing/
https://docs-git-docs-api-usage-flagsmith.vercel.app/advanced-use/real-time-flags