List User Events

v1.0.0

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.

Input

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "number",
      "description": "Maximum number of items which may be returned."
    },
    "since": {
      "type": "string",
      "description": "Timestamp to only include items created since then."
    },
    "teamId": {
      "type": "string"
    },
    "types": {
      "type": "string",
      "description": "Comma-delimited list of event \\\"types\\\" to filter the results by."
    },
    "until": {
      "type": "string",
      "description": "Timestamp to only include items created until then."
    },
    "userId": {
      "type": "string",
      "description": "When retrieving events for a Team, the `userId` parameter may be specified to filter events generated by a specific member of the Team."
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Successful response.",
  "required": [
    "events"
  ],
  "properties": {
    "events": {
      "type": "array",
      "description": "Array of events generated by the User.",
      "items": {
        "type": "object",
        "description": "Array of events generated by the User.",
        "required": [
          "id",
          "text",
          "entities",
          "createdAt",
          "userId"
        ],
        "properties": {
          "createdAt": {
            "type": "number",
            "description": "Timestamp (in milliseconds) of when the event was generated."
          },
          "entities": {
            "type": "array",
            "description": "A list of \"entities\" within the event `text`. Useful for enhancing the displayed text with additional styling and links.",
            "items": {
              "type": "object",
              "description": "A list of \"entities\" within the event `text`. Useful for enhancing the displayed text with additional styling and links.",
              "required": [
                "type",
                "start",
                "end"
              ],
              "properties": {
                "end": {
                  "type": "number",
                  "description": "The index of where the entity ends within the `text` (non-inclusive)."
                },
                "start": {
                  "type": "number",
                  "description": "The index of where the entity begins within the `text` (inclusive)."
                },
                "type": {
                  "type": "string",
                  "description": "The type of entity.",
                  "enum": [
                    "target",
                    "author",
                    "bitbucket_login",
                    "bold",
                    "deployment_host",
                    "dns_record",
                    "git_link",
                    "github_login",
                    "gitlab_login",
                    "hook_name",
                    "integration",
                    "edge-config",
                    "link",
                    "project_name",
                    "scaling_rules",
                    "env_var_name",
                    "system"
                  ]
                }
              }
            }
          },
          "id": {
            "type": "string",
            "description": "The unique identifier of the Event."
          },
          "text": {
            "type": "string",
            "description": "The human-readable text of the Event."
          },
          "user": {
            "type": "object",
            "description": "Metadata for the User who generated the event.",
            "required": [
              "avatar",
              "email",
              "uid",
              "username"
            ],
            "properties": {
              "avatar": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "slug": {
                "type": "string"
              },
              "uid": {
                "type": "string"
              },
              "username": {
                "type": "string"
              }
            }
          },
          "userId": {
            "type": "string",
            "description": "The unique identifier of the User who generated the event."
          }
        }
      }
    }
  }
}