docs: Add Stats API endpoint documentation (#463)#480
Open
tlfranko-star wants to merge 15 commits into
Open
Conversation
Migrate and update Stats API docs from legacy markdown to RST format. Verified all table names and columns against Mautic 7.0 source code.
Add :widths: directive to list-table definitions to prevent narrow columns that cause text to wrap mid-word in the rendered output.
Co-authored-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
| @@ -1,14 +1,424 @@ | |||
| Stats | |||
There was a problem hiding this comment.
Ported core API structure, code examples, and response formats from legacy documentation. Updated table list based on verification against Mautic 7.0 source.
Source: https://github.com/mautic/developer-documentation/blob/main/source/includes/_api_endpoint_stats.md
promptless-for-oss
force-pushed
the
promptless/issue-463-stats-api-page
branch
from
0d0be2d to
c073c74
Compare
|
|
||
| <?php | ||
|
|
||
| $where = [ |
There was a problem hiding this comment.
Verified StatsApiController.php handles /stats/{table} route with start, limit, order, and where query parameters. Confirmed default limit of 100 rows.
Per Mautic style guide, capitalize product terms: - Channel in table descriptions - Dynamic Content in section header
Contributor
|
@mautic/core-team can you please help review the content? TIA! ✨ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Open this suggestion in Promptless to view citations and reasoning process
Migrated the Stats API documentation from legacy markdown to RST format, verified against Mautic 7.0 source code. Updated the table list to reflect the 29 stat tables available in 7.0. Added PHP/HTTP examples, query parameters, and categorized table reference. Fixed column widths on all Response properties tables to prevent text wrapping mid-word.