v14

latestOpenAPI 3.0.32026-08-04377889.4 MB

user

List User Events

Retrieves a list of "events" generated by the User on Vercel. Events are generated when the User performs a particular action, such as logging in, creating a deployment, and joining a Team (just to name a few). When the teamId parameter is supplied, then the events that are returned will be in relation to the Team that was specified.

get/v3/events

Query parameters

limitnumber

Maximum number of items which may be returned.

Example:20

Maximum number of items which may be returned.

sincestring

Timestamp to only include items created since then.

Example:2019-12-08T10:00:38.976Z

Timestamp to only include items created since then.

untilstring

Timestamp to only include items created until then.

Example:2019-12-09T23:00:38.976Z

Timestamp to only include items created until then.

typesstring

Comma-delimited list of event "types" to filter the results by.

Example:login,team-member-join,domain-buy

Comma-delimited list of event "types" to filter the results by.

userIdstring

Deprecated. Use principalId instead. If principalId and userId both exist, principalId will be used.

Example:aeIInYVk59zbFF2SxfyxxmuO

Deprecated. Use principalId instead. If principalId and userId both exist, principalId will be used.

principalIdstring

When retrieving events for a Team, the principalId parameter may be specified to filter events generated by a specific principal.

Example:aeIInYVk59zbFF2SxfyxxmuO

When retrieving events for a Team, the principalId parameter may be specified to filter events generated by a specific principal.

projectIdsstring

Comma-delimited list of project IDs to filter the results by.

Example:aeIInYVk59zbFF2SxfyxxmuO

Comma-delimited list of project IDs to filter the results by.

withPayloadstring

When set to true, the response will include the payload field for each event.

Example:true

When set to true, the response will include the payload field for each event.

teamIdstring

Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring

Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

Successful response.

Example response

{
  "events": [
    {
      "id": "uev_bfmMjiMnXfnPbT97dGdpJbCN",
      "text": "You logged in via GitHub",
      "entities": [
        {
          "type": "author",
          "end": 3
        }
      ],
      "type": "login",
      "categories": [
        "deployment"
      ],
      "createdAt": 1632859321020,
      "userId": "zTuNVUXEAvvnNN3IaqinkyMw",
      "payload": {
        "created": "2021-02-10T13:11:49.180Z",
        "key": "my-api-key",
        "ownerId": "team_LLHUOMOoDlqOp8wPE4kFo9pE",
        "id": "env_XCG7t7AIHuO2SBA8667zNUiM",
        "createdBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
        "deletedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
        "updatedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
        "createdAt": 1609492210000,
        "deletedAt": 1609492210000,
        "updatedAt": 1609492210000,
        "projectId": [
          "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
          "prj_2WjyKQmM8ZnGcJsPWMrasEFg"
        ],
        "type": "encrypted",
        "target": [
          "production"
        ]
      }
    }
  ]
}