Skip to content
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.

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

Update ListUsers.py to include Pagination in the Example #2178

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

sadhbh-a
Copy link

What does this PR do?

Add a line on pagination to the code example & clarifies that the USER_DATA_ATTRIBUTES_EMAIL needs to be set locally in order to populate (I think this is useful to note as while testing I kept running into this issue)

We have received multiple tickets in the past for customers confused on why when they run the below command:
curl -X GET "https://api.datadoghq.eu/api/v2/users" \
only 10 users users are returned.
The reason for this is that this command requires pagination.
I think having this in the snippet would help avoid these kinds of tickets.

Examples:
https://datadog.zendesk.com/agent/tickets/1753134
https://datadog.zendesk.com/agent/tickets/1363875
https://datadog.zendesk.com/agent/tickets/1090161
https://datadog.zendesk.com/agent/tickets/1470738

Additional Notes

Review checklist

Please check relevant items below:

  • This PR includes all newly recorded cassettes for any modified tests.

  • This PR does not rely on API client schema changes.

    • The CI should be fully passing.
  • Or, this PR relies on API schema changes and this is a Draft PR to include tests for that new functionality.

    • Note: CI shouldn't be run on this Draft PR, as its expected to fail without the corresponding schema changes.

@sadhbh-a sadhbh-a requested a review from a team as a code owner September 26, 2024 10:53
Copy link

This PR has been automatically marked as stale because it has not had activity in the last 30 days.
If there is no activity for another 90 days, this issue will be automatically closed.

@github-actions github-actions bot added the stale label Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant