Pontos de extremidade da API REST para eventos de linha do tempo

Sobre os eventos de linha do tempo

É possível usar a API REST para exibir diferentes tipos de eventos disparados pela atividade de linha do tempo em problemas e solicitações de pull. Para obter mais informações sobre os eventos específicos que podem ser recebidos, confira "Tipos de eventos de problemas". Para ver a atividade do GitHub fora dos problemas e das solicitações de pull, confira "Tipos de eventos do GitHub".

É possível usar eventos de linha do tempo para exibir informações sobre problemas e solicitações de pull ou determinar quem deve ser notificado sobre comentários de problemas.

Cada pull request é um problema, mas nem todos os problemas são um pull request. Por esse motivo, as ações "compartilhadas" para ambos os recursos, como gerenciamento de destinatários, rótulos e marcos, são fornecidas nos pontos de extremidade de Problemas.

List timeline events for an issue

List all timeline events for an issue.

Tokens de acesso refinados para "List timeline events for an issue"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter pelo menos um dos seguintes conjuntos de permissões:

"Issues" repository permissions (read)
"Pull requests" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "List timeline events for an issue"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number` integer Obrigatório The number that identifies the issue.

Parâmetros de consulta
Nome, Tipo, Descrição
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `1`

Códigos de status de resposta HTTP para "List timeline events for an issue"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`410`	Gone

Exemplos de código para "List timeline events for an issue"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

get/repos/{owner}/{repo}/issues/{issue_number}/timeline

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/issues/ISSUE_NUMBER/timeline

Response

Status: 200

[
  {
    "id": 6430295168,
    "node_id": "LOE_lADODwFebM5HwC0kzwAAAAF_RoSA",
    "url": "https://api.github.com/repos/github/roadmap/issues/events/6430295168",
    "actor": {
      "login": "github",
      "id": 9919,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
      "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/github",
      "html_url": "https://github.com/github",
      "followers_url": "https://api.github.com/users/github/followers",
      "following_url": "https://api.github.com/users/github/following{/other_user}",
      "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/github/subscriptions",
      "organizations_url": "https://api.github.com/users/github/orgs",
      "repos_url": "https://api.github.com/users/github/repos",
      "events_url": "https://api.github.com/users/github/events{/privacy}",
      "received_events_url": "https://api.github.com/users/github/received_events",
      "type": "Organization",
      "site_admin": false
    },
    "event": "locked",
    "commit_id": null,
    "commit_url": null,
    "created_at": "2022-04-13T20:49:13Z",
    "lock_reason": null,
    "performed_via_github_app": null
  },
  {
    "id": 6430296748,
    "node_id": "LE_lADODwFebM5HwC0kzwAAAAF_Roqs",
    "url": "https://api.github.com/repos/github/roadmap/issues/events/6430296748",
    "actor": {
      "login": "github-product-roadmap",
      "id": 67656570,
      "node_id": "MDQ6VXNlcjY3NjU2NTcw",
      "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/github-product-roadmap",
      "html_url": "https://github.com/github-product-roadmap",
      "followers_url": "https://api.github.com/users/github-product-roadmap/followers",
      "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}",
      "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions",
      "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs",
      "repos_url": "https://api.github.com/users/github-product-roadmap/repos",
      "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}",
      "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events",
      "type": "User",
      "site_admin": false
    },
    "event": "labeled",
    "commit_id": null,
    "commit_url": null,
    "created_at": "2022-04-13T20:49:34Z",
    "label": {
      "name": "beta",
      "color": "99dd88"
    },
    "performed_via_github_app": null
  },
  {
    "id": 6635165802,
    "node_id": "RTE_lADODwFebM5HwC0kzwAAAAGLfJhq",
    "url": "https://api.github.com/repos/github/roadmap/issues/events/6635165802",
    "actor": {
      "login": "github-product-roadmap",
      "id": 67656570,
      "node_id": "MDQ6VXNlcjY3NjU2NTcw",
      "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/github-product-roadmap",
      "html_url": "https://github.com/github-product-roadmap",
      "followers_url": "https://api.github.com/users/github-product-roadmap/followers",
      "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}",
      "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions",
      "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs",
      "repos_url": "https://api.github.com/users/github-product-roadmap/repos",
      "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}",
      "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events",
      "type": "User",
      "site_admin": false
    },
    "event": "renamed",
    "commit_id": null,
    "commit_url": null,
    "created_at": "2022-05-18T19:29:01Z",
    "rename": {
      "from": "Secret scanning: dry-runs for enterprise-level custom patterns (cloud)",
      "to": "Secret scanning: dry-runs for enterprise-level custom patterns"
    },
    "performed_via_github_app": null
  },
  {
    "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857",
    "html_url": "https://github.com/github/roadmap/issues/493#issuecomment-1130876857",
    "issue_url": "https://api.github.com/repos/github/roadmap/issues/493",
    "id": 1130876857,
    "node_id": "IC_kwDODwFebM5DZ8-5",
    "user": {
      "login": "octocat",
      "id": 94867353,
      "node_id": "U_kgDOBaePmQ",
      "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": true
    },
    "created_at": "2022-05-19T00:52:15Z",
    "updated_at": "2022-05-19T00:52:15Z",
    "author_association": "COLLABORATOR",
    "body": "🚢  Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/",
    "reactions": {
      "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions",
      "total_count": 0,
      "+1": 0,
      "-1": 0,
      "laugh": 0,
      "hooray": 0,
      "confused": 0,
      "heart": 0,
      "rocket": 0,
      "eyes": 0
    },
    "performed_via_github_app": null,
    "event": "commented",
    "actor": {
      "login": "octocat",
      "id": 94867353,
      "node_id": "U_kgDOBaePmQ",
      "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": true
    }
  }
]