public_events
Creates, updates, deletes, gets or lists a public_events resource.
Overview
| Name | public_events |
| Type | Resource |
| Id | github.activity.public_events |
Fields
The following fields are returned by SELECT queries:
- list_public_events_for_repo_network
- list_public_org_events
- list_public_events_for_user
- list_public_events
Response
| Name | Datatype | Description |
|---|---|---|
id | string | |
actor | object | Actor (title: Actor) |
created_at | string (date-time) | |
org | object | Actor (title: Actor) |
payload | object | (opaque JSON object) (title: CreateEvent) |
public | boolean | |
repo | object | |
type | string |
Response
| Name | Datatype | Description |
|---|---|---|
id | string | |
actor | object | Actor (title: Actor) |
created_at | string (date-time) | |
org | object | Actor (title: Actor) |
payload | object | (opaque JSON object) (title: CreateEvent) |
public | boolean | |
repo | object | |
type | string |
Response
| Name | Datatype | Description |
|---|---|---|
id | string | |
actor | object | Actor (title: Actor) |
created_at | string (date-time) | |
org | object | Actor (title: Actor) |
payload | object | (opaque JSON object) (title: CreateEvent) |
public | boolean | |
repo | object | |
type | string |
Response
| Name | Datatype | Description |
|---|---|---|
id | string | |
actor | object | Actor (title: Actor) |
created_at | string (date-time) | |
org | object | Actor (title: Actor) |
payload | object | (opaque JSON object) (title: CreateEvent) |
public | boolean | |
repo | object | |
type | string |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_public_events_for_repo_network | select | owner, repo | per_page, page | > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. |
list_public_org_events | select | org | per_page, page | > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. |
list_public_events_for_user | select | username | per_page, page | > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. |
list_public_events | select | per_page, page | > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
org | string | The organization name. The name is not case sensitive. |
owner | string | The account owner of the repository. The name is not case sensitive. |
repo | string | The name of the repository without the .git extension. The name is not case sensitive. |
username | string | The handle for the GitHub user account. |
page | integer | The page number of the results to fetch. For more information, see "Using pagination in the REST API." |
per_page | integer | The number of results per page (max 100). For more information, see "Using pagination in the REST API." |
SELECT examples
- list_public_events_for_repo_network
- list_public_org_events
- list_public_events_for_user
- list_public_events
> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
SELECT
id,
actor,
created_at,
org,
payload,
public,
repo,
type
FROM github.activity.public_events
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;
> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
SELECT
id,
actor,
created_at,
org,
payload,
public,
repo,
type
FROM github.activity.public_events
WHERE org = '{{ org }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;
> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
SELECT
id,
actor,
created_at,
org,
payload,
public,
repo,
type
FROM github.activity.public_events
WHERE username = '{{ username }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;
> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
SELECT
id,
actor,
created_at,
org,
payload,
public,
repo,
type
FROM github.activity.public_events
WHERE per_page = '{{ per_page }}'
AND page = '{{ page }}'
;