Skip to content

Documenting "withContactCounts" for campaign API#293

Merged
adiati98 merged 15 commits into
mautic:7.1from
escopecz:MAUT_13385
May 15, 2026
Merged

Documenting "withContactCounts" for campaign API#293
adiati98 merged 15 commits into
mautic:7.1from
escopecz:MAUT_13385

Conversation

@escopecz
Copy link
Copy Markdown
Member

Docs for mautic/mautic#15878. This should be rebased to the 7.1 branch once it exists.

@escopecz escopecz requested a review from a team as a code owner February 17, 2026 09:42
@escopecz escopecz requested review from adiati98 and favour-chibueze and removed request for a team February 17, 2026 09:42
Copy link
Copy Markdown
Contributor

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR, @escopecz! I have some suggestions to address here. TIA! ✨

Comment thread docs/rest_api/campaigns.rst Outdated
Comment thread docs/rest_api/campaigns.rst Outdated
Comment thread docs/rest_api/campaigns.rst Outdated
Comment thread docs/rest_api/campaigns.rst
Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>
@escopecz
Copy link
Copy Markdown
Member Author

@adiati98 thanks for the suggestions! Applied

adiati98
adiati98 previously approved these changes Mar 8, 2026
@adiati98 adiati98 added this to the 7.1 milestone Mar 9, 2026
@adiati98 adiati98 changed the base branch from 5.x to 7.1 March 25, 2026 07:16
@adiati98 adiati98 dismissed their stale review March 25, 2026 07:16

The base branch was changed.

@adiati98 adiati98 requested review from a team and adiati98 March 25, 2026 07:16
Copy link
Copy Markdown
Contributor

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @escopecz,

There's some minor tweak here, and I have a question. TIA! ✨

Comment thread docs/rest_api/campaigns.rst
Comment thread docs/rest_api/campaigns.rst Outdated
Comment thread docs/rest_api/campaigns.rst
Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds REST API documentation for the withContactCounts query parameter on Campaign endpoints, describing the returned contact-count fields and the caching behavior/TTL configuration.

Changes:

  • Documented contactCount and contactCountFetchedAt Campaign properties (gated behind withContactCounts=true).
  • Added withContactCounts to the List Campaigns query parameters and clarified cache TTL behavior in a note.
  • Allowed the acronym “TTL” in Vale’s accepted vocabulary.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/rest_api/campaigns.rst Documents withContactCounts behavior, additional response fields, and caching/TTL configuration notes.
.github/styles/config/vocabularies/Mautic/accept.txt Adds “TTL” to the Vale accept list to prevent linting false-positives.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/rest_api/campaigns.rst Outdated
Comment thread docs/rest_api/campaigns.rst Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 25, 2026 09:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/rest_api/campaigns.rst
@adiati98 adiati98 requested a review from RCheesley April 2, 2026 20:05
Copy link
Copy Markdown
Contributor

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@escopecz a couple of small suggestions here. Also, can you please check the suggestions by copilot and confirm if they're correct? TIA! ✨

Comment thread docs/rest_api/campaigns.rst Outdated
Comment thread docs/rest_api/campaigns.rst Outdated
Copilot AI review requested due to automatic review settings May 13, 2026 19:24
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review is ineligible. To be eligible to request a review, you need a paid Copilot license, or your organization must enable Copilot code review.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 14, 2026 07:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@escopecz escopecz requested a review from adiati98 May 14, 2026 07:56
Comment thread docs/rest_api/campaigns.rst
Copilot AI review requested due to automatic review settings May 15, 2026 08:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review is ineligible. To be eligible to request a review, you need a paid Copilot license, or your organization must enable Copilot code review.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Copy link
Copy Markdown
Contributor

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much, @escopecz! 🚀

@adiati98 adiati98 merged commit c05f967 into mautic:7.1 May 15, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants