Sign in
latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

Project Activity

Get project activity log

Retrieve a project's activity log including logging actions in all environments within a project. This returns a list of objects with records of actions such as:

  • Commits being pushed to the repository
  • A new environment being branched out from the specified environment
  • A snapshot being created of the specified environment

The object includes a timestamp of when the action occurred (created_at), when the action concluded (updated_at), the current state of the action, the action's completion percentage (completion_percent), the environments it applies to and when the activity expires (expires_at).

There are other related information in the payload. The contents of the payload varies based on the type of the activity. For example:

  • An environment.branch action's payload can contain objects representing the environment's parent environment and the branching action's outcome.

  • An environment.push action's payload can contain objects representing the environment, the specific commits included in the push, and the user who pushed.

Expired activities are removed from the project activity log, except the last 100 expired objects provided they are not of type environment.cron or environment.backup.

get/projects/{projectId}/activities

Path parameters

projectIdstring required

Response

idstring required

The identifier of Activity

created_atstring date-time nullable required

The creation date

updated_atstring date-time nullable required

The update date

typestring required

The type of the activity

parametersobject required

The parameters of the activity

projectstring required

The project the activity belongs to

integrationstring

The integration the activity belongs to

environmentsstring[]

The environments related to the activity

state'cancelled' | 'complete' | 'in_progress' | 'pending' | 'scheduled' | 'staged' required

The state of the activity

result'failure' | 'success' nullable required

The result of the activity

started_atstring date-time nullable required

The start date of the activity

completed_atstring date-time nullable required

The completion date of the activity

completion_percentinteger required

The completion percentage of the activity

cancelled_atstring date-time nullable required

The Cancellation date of the activity

timingsobject required

Timings related to different phases of the activity

logstring required

The log of the activity

payloadobject required

The payload of the activity

descriptionstring nullable required

The description of the activity, formatted with HTML

textstring nullable required

The description of the activity, formatted as plain text

expires_atstring date-time nullable required

The date at which the activity will expire