docs: Add Stats API endpoint documentation (#463) by tlfranko-star · Pull Request #480 · mautic/developer-documentation-new

tlfranko-star · 2026-05-03T22:42:32Z

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.

Closes #463

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>

Per Mautic style guide, capitalize product terms: - Channel in table descriptions - Dynamic Content in section header

adiati98 · 2026-05-11T08:35:34Z

@mautic/core-team can you please help review the content? TIA! ✨

escopecz

Looks great! 👍

adiati98

Hi @tlfranko-star,

Thank you so much for the PR. This looks great so far! ✨

We want to keep the structure (headers, position description, etc.) and wordings (whenever applicable) consistent throughout the docs.

I left some suggestions here as examples of what need to be changed. There are more to fix than what I suggested here. Please review and update your PR accordingly.

You can take a look at other pages as reference, such as this file: docs/rest_api/emails.rst.

Please let me know if you have any question, and feel free to tag me once you're done. 🙂

adiati98 · 2026-05-18T17:33:08Z

@promptless-for-oss please address the suggestions.

We want to keep the structure (headers, position description, etc.) and wordings (whenever applicable) consistent throughout the docs.

I left some suggestions here as examples of what need to be changed. There are more to fix than what I suggested here. Please review and update the PR accordingly.

You can take a look at other pages as reference, such as this file: docs/rest_api/emails.rst.

- Convert 'Using Mautic's API Library' to proper header format - Capitalize HTTP throughout - Move descriptions to appear right after section headers - Convert 'HTTP Request' and 'Response' from bold to proper headers - Use bullet point format for response status descriptions - Remove unnecessary vale off/on statements - Change 'Response properties' to use dashes underline for subsection

promptless-for-oss · 2026-05-18T20:27:38Z

I've addressed all the reviewer feedback to improve consistency with other API documentation pages. The changes include:

Converted bold text headers ("Using Mautic's API Library", "HTTP Request", "Response", "Response properties") to proper RST section headers with appropriate underlines
Capitalized "HTTP" for consistency
Moved section descriptions to appear immediately after headers
Standardized response status format to bullet-point style: * Returns ``200 OK`` when...
Removed unnecessary .. vale off / .. vale on statements around headers already in sentence case
Applied these patterns throughout the entire stats.rst file following the emails.rst reference

The changes have been pushed to the PR.

adiati98

@promptless-for-oss we need to address the Vale warnings here.

Address reviewer feedback to fix Vale linting warnings: - Wrap do-not-contact section with vale off/on directives - Wrap "Web page visit tracking" description with vale off/on - Wrap webhook_logs table content with vale off/on - Simplify "Client application information" to "Client information" - Simplify "Browser user agent string" to "User agent string" (3 locations)

promptless-for-oss · 2026-05-22T10:24:22Z

Thanks for the review feedback @adiati98! I've applied all the suggested Vale fixes:

Added .. vale off / .. vale on directives around the lead_donotcontact section
Added Vale directives around "Web page visit tracking" in page_hits
Added Vale directives around the webhook_logs table content
Simplified "Client application information" to "Client information"
Changed "Browser user agent string" to "User agent string" in lead_utmtags, page_hits, and video_hits

The changes have been pushed to this PR.

adiati98

@promptless-for-oss please address the suggestions and the suggestions that you haven't addressed.

- Remove premature vale on after page_hits description - Add vale off/on around page_redirects section

promptless-for-oss · 2026-05-22T11:00:31Z

Applied all three reviewer suggestions:

Removed the premature .. vale on after the page_hits description
Added .. vale off before the page_redirects section
Added .. vale on after the page_redirects table

Changes have been pushed to the branch. Please let me know if anything else needs adjustment.

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

adiati98

@promptless-for-oss please address the suggestions

@adiati98

- Change "Get available stat tables" to "Get stat tables" (shorter heading) - Fix Stats properties table widths from 25/10/65 to 25/15/60 - Rename "Where expressions" to "The expr parameter in where expressions" Addresses PR mautic#480 review feedback from @adiati98.

promptless-for-oss · 2026-05-29T08:59:40Z

Applied all three reviewer suggestions:

Changed "Get available stat tables" heading to "Get stat tables" with asterisk underline
Fixed Stats properties table :widths: from 25 10 65 to 25 15 60
Renamed "Where expressions" to "The expr parameter in where expressions" with tilde underline

Changes have been committed and pushed to the branch.

adiati98

@promptless-for-oss please address the suggestions

- Update title from 'where expressions' to '$where arrays' for clarity - Convert expr method bullet list to list-table for consistency with other pages

promptless-for-oss · 2026-05-31T09:06:34Z

Done! I've addressed both suggestions:

Updated the section title to The ``expr`` parameter in ``$where`` arrays for clarity
Converted the expression methods list to a list-table for consistency with other pages

The changes have been pushed to this branch.

adiati98

@promptless-for-oss please address the suggestions

@adiati98

Update descriptions in the expr parameter table per reviewer feedback: - Change "specified value" to "specified input" for consistency - Change "provided list" to "specified array" for in/notIn operators - Change "two specified values" to "two specified inputs" for between operator Addresses feedback from @adiati98 to avoid word duplication.

promptless-for-oss · 2026-05-31T09:27:40Z

Thanks for the review feedback @adiati98! I've applied both suggestions to improve clarity by avoiding word duplication in the expression methods table:

Changed "specified value" to "specified input" for eq, neq, lt, lte, gt, gte operators
Changed "provided list" to "specified array" for in and notIn operators
Changed "two specified values" to "two specified inputs" for between operator

The changes have been pushed to this PR.

adiati98 · 2026-06-01T07:03:56Z

@promptless-for-oss please backport the changes here to 7.1, 6.0, and 5.x branches. Create a PR for each branch.

promptless-for-oss · 2026-06-01T07:08:22Z

I've created backport PRs for the Stats API documentation:

✅ Successfully created:

❌ Failed:

7.1 branch: Unable to create the backport due to a branch synchronization issue. I've escalated this to the Promptless team and will follow up once resolved.

The 5.x and 6.0 PRs contain the identical Stats API endpoint documentation from this PR.

adiati98 · 2026-06-01T10:24:27Z

@promptless-for-oss backport the changes here to 7.1 branch.

promptless-for-oss · 2026-06-01T10:26:13Z

Done! I've created the backport to branch 7.1.

Backport PR: #515

The PR contains the complete Stats API documentation targeting the 7.1 branch.

adiati98

Thank you, @tlfranko-star! 🚀

Backport of Stats API documentation from PR #480 (branch promptless/issue-463-stats-api-page). Documents the Stats API endpoints for obtaining statistical data from Mautic's database tables. Includes: - Complete JSON response examples showing all table columns - Detailed column documentation for all 32 available stat tables - Column name, type, and description for each table

promptless Bot and others added 3 commits May 3, 2026 22:08

Add Stats API endpoint documentation (mautic#463)

bbdd9b6

Migrate and update Stats API docs from legacy markdown to RST format. Verified all table names and columns against Mautic 7.0 source code.

Fix RST table column widths in Stats API docs

4ff64e5

Add :widths: directive to list-table definitions to prevent narrow columns that cause text to wrap mid-word in the rendered output.

docs: Add Stats API endpoint documentation (mautic#463)

c073c74

Co-authored-by: promptless[bot] <promptless[bot]@users.noreply.github.com>

promptless-for-oss reviewed May 3, 2026

View reviewed changes

Comment thread docs/rest_api/stats.rst

tlfranko-star requested a review from a team May 3, 2026 22:42

promptless-for-oss force-pushed the promptless/issue-463-stats-api-page branch from 0d0be2d to c073c74 Compare May 3, 2026 22:42

tlfranko-star requested review from adiati98 and favour-chibueze May 3, 2026 22:42

promptless-for-oss reviewed May 3, 2026

View reviewed changes

Comment thread docs/rest_api/stats.rst

promptless Bot added 2 commits May 3, 2026 23:54

Fix Mautic product term capitalization in Stats API docs

83593e1

Per Mautic style guide, capitalize product terms: - Channel in table descriptions - Dynamic Content in section header

Merge branch '7.0' into promptless/issue-463-stats-api-page

824961d

adiati98 requested a review from a team May 11, 2026 08:35

Merge branch '7.0' into promptless/issue-463-stats-api-page

f5610df

escopecz previously approved these changes May 11, 2026

View reviewed changes

promptless Bot added 9 commits May 11, 2026 10:37

Merge branch '7.0' into promptless/issue-463-stats-api-page

a50a477

Merge branch '7.0' into promptless/issue-463-stats-api-page

c1eb0d9

Merge branch '7.0' into promptless/issue-463-stats-api-page

de6c2ee

Merge branch '7.0' into promptless/issue-463-stats-api-page

b54ef50

Merge branch '7.0' into promptless/issue-463-stats-api-page

a5b7499

Merge branch '7.0' into promptless/issue-463-stats-api-page

86e20ed

Merge branch '7.0' into promptless/issue-463-stats-api-page

a9e3dfe

Merge branch '7.0' into promptless/issue-463-stats-api-page

0ca8ddd

Merge branch '7.0' into promptless/issue-463-stats-api-page

c842257

adiati98 requested changes May 17, 2026

View reviewed changes

Merge branch '7.0' into promptless/issue-463-stats-api-page

5816ef3

promptless-for-oss dismissed escopecz’s stale review via 5ba536c May 18, 2026 20:26

Apply suggestion from @adiati98

d0842d2

adiati98 requested changes May 22, 2026

View reviewed changes

Comment thread docs/rest_api/stats.rst Outdated

Comment thread docs/rest_api/stats.rst

Comment thread docs/rest_api/stats.rst

Apply reviewer Vale directive suggestions

528ad81

- Remove premature vale on after page_hits description - Add vale off/on around page_redirects section

Apply suggestions from code review

05f93e9

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

adiati98 requested changes May 29, 2026

View reviewed changes

Comment thread docs/rest_api/stats.rst Outdated

Comment thread docs/rest_api/stats.rst Outdated

Comment thread docs/rest_api/stats.rst Outdated

adiati98 requested changes May 31, 2026

View reviewed changes

Comment thread docs/rest_api/stats.rst Outdated

Comment thread docs/rest_api/stats.rst Outdated

docs: Update expr parameter section per reviewer feedback

b1e6272

- Update title from 'where expressions' to '$where arrays' for clarity - Convert expr method bullet list to list-table for consistency with other pages

adiati98 requested changes May 31, 2026

View reviewed changes

Comment thread docs/rest_api/stats.rst Outdated

Comment thread docs/rest_api/stats.rst Outdated

This was referenced Jun 1, 2026

Backport Stats API documentation to 5.x #510

Merged

Backport Stats API documentation to 6.0 #511

Merged

promptless-for-oss mentioned this pull request Jun 1, 2026

Backport Stats API documentation to 7.1 #515

Merged

adiati98 approved these changes Jun 1, 2026

View reviewed changes

adiati98 merged commit 6e9d0e3 into mautic:7.0 Jun 1, 2026
4 of 5 checks passed

promptless-for-oss deleted the promptless/issue-463-stats-api-page branch June 1, 2026 10:36

Conversation

tlfranko-star commented May 3, 2026 • edited by adiati98 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adiati98 commented May 11, 2026

Uh oh!

escopecz left a comment

Choose a reason for hiding this comment

Uh oh!

adiati98 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adiati98 commented May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

promptless-for-oss commented May 18, 2026

Uh oh!

adiati98 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

promptless-for-oss commented May 22, 2026

Uh oh!

adiati98 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

promptless-for-oss commented May 22, 2026

Uh oh!

adiati98 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

promptless-for-oss commented May 29, 2026

Uh oh!

adiati98 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

promptless-for-oss commented May 31, 2026

Uh oh!

adiati98 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

promptless-for-oss commented May 31, 2026

Uh oh!

adiati98 commented Jun 1, 2026

Uh oh!

promptless-for-oss commented Jun 1, 2026

Uh oh!

adiati98 commented Jun 1, 2026

Uh oh!

promptless-for-oss commented Jun 1, 2026

Uh oh!

adiati98 left a comment

tlfranko-star commented May 3, 2026 •

edited by adiati98

Loading

adiati98 commented May 18, 2026 •

edited

Loading