如何通过GitHub REST API获取用户相关的Issue事件数据？

Hey there! Let's tackle your question about getting user-related Issue events via the GitHub REST API. Here's what you need to know:

The Most Feasible Approach: Filter GET /users/:username/received_events #

While there isn't a dedicated API endpoint that only returns user-related Issue events, the GET /users/:username/received_events endpoint you mentioned is actually the closest fit. The trick is to filter the returned events by their type field to isolate Issue-related activity.

This endpoint returns all events that involve the target user (e.g., someone @mentions them in an Issue, comments on their Issue, or modifies an Issue they're associated with)—and crucially, this works even if the user isn't assigned to the Issue.

Which Event Types to Filter For #

Look for these event types in the response to capture all relevant Issue activity:

• IssuesEvent: Triggers when an Issue is opened, closed, reopened, or edited (and the event involves the user)
• IssueCommentEvent: Triggers when someone comments on an Issue that's relevant to the user (e.g., an Issue they created, or one where they were @mentioned)
• AssignedEvent/UnassignedEvent: Triggers when the user is assigned to or removed from an Issue
• LabeledEvent/UnlabeledEvent: Triggers when labels are added/removed from an Issue the user cares about
• MilestonedEvent/DemilestonedEvent: Triggers when an Issue the user is associated with is added to or removed from a milestone

Example Workflow #

1. Make a request to GET /users/:username/received_events (you can add a per_page parameter to fetch more results at once, up to 100)
2. Parse the JSON response, and filter the events array to only include entries where the type matches one of the Issue-related types listed above
3. Extract the relevant details from each filtered event (like the Issue title, action taken, actor, and timestamp) from the payload field

Here's a snippet of what a filtered IssuesEvent might look like:

{
  "id": "1234567890",
  "type": "IssuesEvent",
  "actor": {
    "login": "another-user",
    "id": 12345
  },
  "repo": {
    "name": "owner/repo-name"
  },
  "payload": {
    "action": "opened",
    "issue": {
      "title": "Fix broken login flow",
      "number": 42,
      "body": "@your-username Can you take a look at this?",
      "user": {
        "login": "another-user"
      }
    }
  },
  "created_at": "2024-05-20T14:30:00Z"
}

Notes on Deprecated/Unfit Endpoints #

• The old GET /repos/:owner/:repo/issues/:issue_number/events endpoint is indeed deprecated—its replacement is GET /repos/:owner/:repo/issues/:issue_number/timeline, but this only returns events for a single specific Issue, which doesn't fit your need for user-wide events.
• Endpoints like GET /issues or GET /user/issues are limited to Issues where the user is assigned, mentioned, or is the author, but they don't return the event activity (like who commented, when it was closed, etc.)—so they're not suitable for your use case.

If you're looking for events the user themselves initiated (rather than events that involve them), you can use GET /users/:username/events instead, and apply the same type filtering.

内容的提问来源于stack exchange，提问作者AoiHosizora