Skip to content

docs: Document withContactCounts parameter for Campaigns API #298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
promptless-for-oss wants to merge 1 commit into from
Closed

docs: Document withContactCounts parameter for Campaigns API #298

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/rest_api/campaigns.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,12 @@
* - ``events``
- array
- Array of Event entities for the Campaign - see below
* - ``contactCount``
- int
- Number of Contacts in the Campaign. Only included when ``withContactCounts`` is set in the request.

Check warning on line 155 in docs/rest_api/campaigns.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is set').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is set').", "location": {"path": "docs/rest_api/campaigns.rst", "range": {"start": {"line": 155, "column": 85}}}, "severity": "INFO"}
* - ``contactCountFetchedAt``
- datetime/null
- Timestamp when the Contact count was last fetched. Only included when ``withContactCounts`` is set in the request.

Check warning on line 158 in docs/rest_api/campaigns.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is set').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is set').", "location": {"path": "docs/rest_api/campaigns.rst", "range": {"start": {"line": 158, "column": 100}}}, "severity": "INFO"}


**Event Properties**
Expand Down Expand Up @@ -246,6 +252,8 @@
- Only return currently published entities
* - ``minimal``
- Return only array of entities without additional lists in it
* - ``withContactCounts``
Copy link
Copy Markdown
Author

@promptless-for-oss promptless-for-oss Feb 24, 2026

Choose a reason for hiding this comment

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

Citation: Based on PR #15878 which adds withContactCounts query parameter to CampaignApiController.php. The implementation shows the parameter returns contactCount and contactCountFetchedAt fields, with counts cached for 12 hours via campaign_contact_count_cache_ttl.
View source

- Include ``contactCount`` and ``contactCountFetchedAt`` in the response for each Campaign. These values are cached for 12 hours by default.

Check warning on line 256 in docs/rest_api/campaigns.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('are cached').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are cached').", "location": {"path": "docs/rest_api/campaigns.rst", "range": {"start": {"line": 256, "column": 111}}}, "severity": "INFO"}


**Response**
Expand Down
Loading