Schemas

An account's public activity: pushes, pull requests, issues, comments, reviews, releases, stars and forks, with the repository, branch or tag, issue or pull request number and title, and when.

Endpoints

1 endpoint returns activity on GitHub.

Schema

Every endpoint above returns an array of these objects as data, with a page object. The standard meta comes with every response.

platformstring

Platform ID (github, …).

idstring

The activity's ID: the platform's own event ID, else one derived from the repository, the kind and the month the platform groups it in (torvalds/linux:push:2026-05), stable across fetches.

typestring

What the account did: push (commits to a branch or tag), create and delete (a repository, branch or tag: ref_type), fork, star, watch (subscribed to a repository's notifications), issue and pull_request (opened, closed, merged…: action), review (of a pull request), comment (on an issue, pull request or commit), release, member (added to or left a repository or group), wiki (edited its pages), discussion; other: the platform's own kind in platform_type. New values may be added; treat any other value as other.

One ofpushcreatedeleteforkstarwatchissuepull_requestreviewcommentreleasememberwikidiscussionother

platform_typestringnullable

The platform's own name for the kind (PushEvent on GitHub, "pushed to" on GitLab, commit_repo on Codeberg); null when the source shows none.

actionstringnullable

What happened to the target, for kinds with more than one action: opened, closed, reopened, merged, edited, created, deleted, published (a release), approved, changes_requested, commented, dismissed (a review), ready_for_review, added and removed (a member), joined and left, assigned, unassigned, labeled, unlabeled, review_requested, synchronized (new commits on a pull request). Null for a kind that is its own action (push, star, fork) or when not shown. New values may be added; treat any other value as null.

One ofopenedclosedreopenedmergededitedcreateddeletedpublishedapprovedchanges_requestedcommenteddismissedready_for_reviewaddedremovedjoinedleftassignedunassignedlabeledunlabeledreview_requestedsynchronized

created_atstring date-time

When it happened, RFC 3339 UTC, never later than the fetch. A date-only value is listed in approximate_fields; an item grouping a period's commits (GitHub's contribution timeline) is dated by the period's last day, or the day of the fetch while the period runs.

actorobject

The account that acted; fields null when not shown.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

repositoryobjectnullable

The repository it happened in (for a fork, the one forked; for a create of a repository, the new one); null when it happened in none (joining a group).

ShowHide 3 child fields
idstringnullable

Platform-native repository ID (string); null when the source names it by path only.

full_namestringnullable

The repository's path, owner and name (torvalds/linux; nested groups on GitLab: group/subgroup/name); null when the source gives its ID only.

urlstring urinullable

The repository's page (https://github.com/torvalds/linux); null when unknown.

refstringnullable

The branch or tag pushed to, created or deleted, by its short name (main, v1.2.0; never refs/heads/…); null for other kinds and a created repository.

ref_typestringnullable

What ref names, or what was created or deleted: branch, tag, or repository (a create or delete of the repository itself, with ref null); null for other kinds. New values may be added; treat any other value as null.

One ofbranchtagrepository

head_shastringnullable

For a push, or a create of a branch or tag by a push, the commit the branch or tag points to after it (a full hexadecimal commit hash); null for other kinds or when not shown.

targetobjectnullable

What the action was on, beyond the repository: the issue, pull request, release, discussion, wiki page or commit, the fork created, the member added; null for a push, a star and a create or delete of a ref.

ShowHide 5 child fields
typestring

The kind of thing acted on: issue, pull_request (a GitLab merge request), release, discussion, wiki_page, commit (a commit comment), repository (the fork created), profile (the member added); other: a platform's own kind. New values may be added; treat any other value as other.

One ofissuepull_requestreleasediscussionwiki_pagecommitrepositoryprofileother

idstringnullable

The target's platform-native ID (a commit's hash); null when not shown.

numberintegernullable

An issue's, pull request's or discussion's number in its repository (#1089); null for other targets.

titlestringnullable

The target's title as the platform shows it (an issue's or pull request's title, a release's name, the fork's path, the member's username); null when the source does not carry it (GitHub's events omit a pull request's title).

urlstring urinullable

The target's page; null when unknown.

textstringnullable

What the account wrote in this action: a comment's or a review's body, as plain text or Markdown as the platform holds it; null for kinds with no text of their own or an empty review.

urlstring urinullable

The page that shows what was done: the comment, the issue or pull request, the release, the pushed commits, the fork, else the repository; null when there is none.

metricsobject

Counts of this action; null = not shown, 0 = zero.

ShowHide 1 child field
commit_countintegernullable

For a push, or a create of a branch or tag by a push, the commits it added (for a period's group, the commits in the period); null for other kinds or when the platform does not say.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 1 child field
githubobjectnullable

GitHub's own fields.

ShowHide 2 child fields
period_start_atstring date-timenullable

For an item that groups the commits an account made to one repository in a month (GitHub's contribution timeline), the month's first day, RFC 3339 UTC; created_at is then the month's last day, or the day of the fetch for the month still running. Null for a single action.

repository_languagestringnullable

For a created repository on the contribution timeline, its main language as GitHub shows it (JavaScript); null for other items and on the event feed.

approximate_fieldsstring[]

JSON paths of values the platform gives only by day or month (created_at on GitHub's contribution timeline). [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none; null already means unknown for every other field. [] when every list is known.

Item errors

Besides the request-level errors every endpoint can return, activity endpoints return:

CodeHTTPRetryMeaningWhat to do
not_found404NoThe item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).Check the link or ID. Do not retry.
private_or_unavailable403NoThe item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.Only public items can be fetched. Do not retry.

Last updated