> ## Documentation Index
> Fetch the complete documentation index at: https://promptwatch.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List project events

> Project events grouped by UTC day (prompts added or deleted, action items completed). Join on `date` with visibility or sentiment time series to explain movements.



## OpenAPI

````yaml /v2/openapi.json get /events
openapi: 3.0.0
info:
  title: Promptwatch API v2
  description: >-
    API v2 for customer integrations with Promptwatch monitoring platform. This
    version provides improved structure, additional endpoints, and enhanced
    functionality.
  version: 2.0.0
  contact:
    name: Promptwatch Support
    email: team@promptwatch.com
    url: https://promptwatch.com
  license:
    name: Commercial
    url: https://promptwatch.com/terms-and-conditions
servers:
  - url: https://server.promptwatch.com/api/v2
    description: Promptwatch API v2
security: []
tags:
  - name: Authentication
    description: API key validation and authentication
  - name: Content
    description: >-
      AI content generation and optimization. Create content asynchronously and
      poll for results.
  - name: Content Agent
    description: >-
      Content Agent (automated content) lifecycle: project settings, scheduled
      slots, review (accept/decline), and publish.
  - name: Content Gap
    description: Content gap analysis and recommendations
  - name: Publishing
    description: >-
      Publish content to a connected CMS, or record a live URL, and track the
      published page
  - name: Models
    description: Available LLM models
  - name: Monitors
    description: Monitor management and CRUD operations
  - name: Page Tracker
    description: Track URLs and inspect citation stats, responses, and prompts
  - name: Prompts
    description: Prompt management and operations
  - name: Query Fanouts
    description: ChatGPT query fanout keywords
  - name: Responses
    description: LLM response data and analytics
  - name: Tags
    description: Tag management for prompts
  - name: Topics
    description: Topic management for prompts
  - name: Actions
    description: Action items (GEO suggestions and tasks)
  - name: Personas
    description: Persona configuration for monitors
  - name: Brands
    description: Brand management for competitive analysis
  - name: Visibility
    description: Brand visibility time series and competitor heatmaps
  - name: Events
    description: >-
      Dated project events such as prompts added and actions completed, for
      annotating time series
  - name: Citations
    description: Citation analytics from AI responses
  - name: Analytics
    description: Visitor analytics, AI crawler logs, sentiment, and brand visibility trends
  - name: Projects
    description: Project management (organization-level keys only)
  - name: Sitemap
    description: Sitemap crawl progress and discovered URLs
  - name: Site Health
    description: >-
      Crawled pages with SEO issues (titles, meta descriptions, H1, thin
      content)
  - name: Socials
    description: >-
      Social media citations (Reddit posts and YouTube videos) found in LLM
      responses
  - name: Ads Radar
    description: Sponsored ads captured in AI answers
  - name: Shopping
    description: Product appearances in AI shopping answers and tracked products
paths:
  /events:
    get:
      tags:
        - Events
      summary: List project events
      description: >-
        Project events grouped by UTC day (prompts added or deleted, action
        items completed). Join on `date` with visibility or sentiment time
        series to explain movements.
      operationId: listEvents
      parameters:
        - schema:
            type: string
            format: date
          in: query
          name: startDate
          required: false
          description: Start date for events data (YYYY-MM-DD). Max range 90 days.
        - schema:
            type: string
            format: date
          in: query
          name: endDate
          required: false
          description: End date for events data (YYYY-MM-DD). Max range 90 days.
        - schema:
            type: string
            format: uuid
          in: query
          name: llmMonitorId
          required: false
          description: Filter by specific LLM monitor ID
        - schema:
            type: string
            format: uuid
          in: query
          name: promptId
          required: false
          description: Filter by specific prompt ID
        - schema:
            type: integer
            default: 1
            minimum: 1
          in: query
          name: page
          required: false
          description: >-
            Page of completed actions (1-based, default 1). Prompt groups for
            the window are included on every page.
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 200
          in: query
          name: size
          required: false
          description: Completed actions per page (default 200, max 200)
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  events:
                    type: array
                    items:
                      type: object
                      properties:
                        date:
                          type: string
                          format: date
                          description: >-
                            UTC calendar day (YYYY-MM-DD) — join key for time
                            series
                        items:
                          type: array
                          description: Events on this day, sorted by occurredAt
                          items:
                            oneOf:
                              - type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - action
                                    description: Completed action item
                                  occurredAt:
                                    type: string
                                    format: date-time
                                    description: ISO instant when the action was completed
                                  action:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                        format: uuid
                                        description: Completed action id
                                      type:
                                        type: string
                                        enum:
                                          - WEBSITE_PERFORMANCE
                                          - WEBSITE_HEALTH
                                          - CONTENT_GAP
                                          - SENTIMENT
                                          - REDDIT_SOCIAL
                                          - SETUP
                                          - UNTRACKED_PAGE
                                          - UNTAPPED_PAGE
                                          - OFFSITE_MENTION
                                          - CUSTOM
                                        description: Unified action type
                                      status:
                                        type: string
                                        enum:
                                          - done
                                        description: Completed action status
                                      title:
                                        type: string
                                        description: Action title
                                    required:
                                      - id
                                      - type
                                      - status
                                      - title
                                    additionalProperties: false
                                required:
                                  - type
                                  - occurredAt
                                  - action
                                additionalProperties: false
                              - type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - prompts_created
                                      - prompts_deleted
                                    description: >-
                                      Prompt create or delete group for one
                                      monitor on this day
                                  occurredAt:
                                    type: string
                                    format: date-time
                                    description: >-
                                      ISO instant of the earliest prompt in the
                                      group
                                  monitor:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                        format: uuid
                                        description: Monitor the prompts belong to
                                      name:
                                        type: string
                                        nullable: true
                                        description: Monitor display name
                                    required:
                                      - id
                                      - name
                                    additionalProperties: false
                                  prompts:
                                    type: array
                                    description: >-
                                      Prompt ids and timestamps in this group;
                                      count is prompts.length
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: string
                                          format: uuid
                                          description: Prompt id
                                        occurredAt:
                                          type: string
                                          format: date-time
                                          description: >-
                                            ISO instant the prompt was created or
                                            deleted
                                      required:
                                        - id
                                        - occurredAt
                                      additionalProperties: false
                                required:
                                  - type
                                  - occurredAt
                                  - monitor
                                  - prompts
                                additionalProperties: false
                      required:
                        - date
                        - items
                      additionalProperties: false
                    description: UTC days that have events, sorted by date
                  total:
                    type: integer
                    description: Total completed actions matching the request
                  page:
                    type: integer
                    description: Page number (1-based)
                  size:
                    type: integer
                    description: Page size
                  totalPages:
                    type: integer
                    description: Total pages for this page size
                required:
                  - events
                  - total
                  - page
                  - size
                  - totalPages
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Bad Request
                  code: DATE_RANGE_TOO_LARGE
                  message: Date range cannot exceed 90 days
                properties:
                  error:
                    type: string
                    description: Error label
                  code:
                    type: string
                    description: Optional machine-readable code (e.g. DATE_RANGE_TOO_LARGE)
                  message:
                    type: string
                    description: Reason the request was rejected
                required:
                  - error
                  - message
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Unauthorized
                  message: Missing or invalid X-API-Key header.
                properties:
                  error:
                    type: string
                    description: Error category (often aligned with HTTP semantics)
                  code:
                    type: string
                    description: Optional machine-readable code
                  message:
                    type: string
                    description: Human-readable explanation
                  details:
                    type: object
                    description: Optional structured detail (e.g. validation)
                    additionalProperties: true
                required:
                  - error
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: INTERNAL_ERROR
                  message: An unexpected error occurred while listing events.
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - INTERNAL_ERROR
                    example: INTERNAL_ERROR
                  message:
                    type: string
                    description: Human-readable error message
                    example: An unexpected error occurred
                required:
                  - code
                  - message
                additionalProperties: false
              example:
                code: INTERNAL_ERROR
                message: An unexpected error occurred
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authentication. Get yours from the Promptwatch dashboard
        under Settings > API Keys.

````