Grepr Activity Logs API

openapi: 3.2.0
info:
  title: Grepr Activity Logs API
  version: 1.0.0
  description: 'Operations tagged Activity Logs across 2 of this provider''s published API definitions: grepr-openapi.json, grepr.json. Each path carries the servers of the definition it was published in.'
tags:
- description: View and search activity logs for auditing, monitoring, and troubleshooting
  name: Activity Logs
paths:
  /v1/activity-logs/search:
    post:
      description: Search activity logs with flexible filtering and pagination. Logs are returned as LogEvent objects with metadata stored in attributes and tags. Full-text search is supported on the message field using PostgreSQL's text search capabilities. All list filters are optional - null or empty lists mean 'match all' for that field.
      operationId: searchActivityLogs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivityLogsSearch'
        description: Search criteria for activity logs
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemsCollectionLogEvent'
          description: activity logs retrieved successfully
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Search activity logs
      tags:
      - Activity Logs
components:
  schemas:
    ItemsCollectionLogEvent:
      properties:
        items:
          default: []
          items:
            $ref: '#/components/schemas/LogEvent'
          type: array
      type: object
    LogEvent:
      description: A log event.
      properties:
        attributes:
          additionalProperties:
            $ref: '#/components/schemas/Any'
          description: Attributes associated with the event, a map from attribute name to attribute value, which may be a nested map or list.
          type: object
        eventTimestamp:
          description: Event timestamp that is in the record. Milliseconds from epoch.
          format: int64
          type: integer
        id:
          description: Id of the event.
          example: 034JA9FJ
          type: string
        message:
          description: The log message.
          example: This is a log message.
          type: string
        receivedTimestamp:
          description: Timestamp when the event was received by Grepr. Milliseconds from epoch.
          format: int64
          type: integer
        severity:
          description: The log severity. Higher numbers mean higher severity, following the OTel format 1-24.
          format: int32
          type: integer
        tags:
          additionalProperties:
            description: Tags associated with the event, a map from tag name to set of tag values.
            items:
              description: Tags associated with the event, a map from tag name to set of tag values.
              type: string
            type: array
            uniqueItems: true
          description: Tags associated with the event, a map from tag name to set of tag values.
          type: object
      required:
      - eventTimestamp
      - id
      - receivedTimestamp
      type: object
    ResourceFilter:
      description: Resource filter for activity logs
      example:
      - resourceId: int-123
        resourceType: INTEGRATION
      - resourceId: job-456
        resourceType: JOB
      properties:
        resourceId:
          description: Specific resource ID to filter by. If null, matches all resources of this type in the organization.
          example: int-123
          type: string
        resourceType:
          description: Resource type to filter by
          enum:
          - INTEGRATION
          - JOB
          - DATASET
          - TEMPLATE
          - TEAM
          - USER
          - ORGANIZATION_SETTINGS
          - SERVICE_ACCOUNT
          - ORGANIZATION
          - BILLING
          - ISSUE
          example: INTEGRATION
          type: string
      required:
      - resourceType
      type: object
    ActivityLogsSearch:
      description: Activity logs search criteria
      properties:
        endTime:
          description: End of time range filter. Must be a valid ISO timestamp in UTC.
          example: '2024-01-01T23:59:59Z'
          format: date-time
          type: string
        limit:
          default: 100
          description: Maximum number of results to return
          example: 100
          format: int32
          maximum: 1000
          minimum: 1
          type: integer
        logTypes:
          default: []
          description: Optional filter by log types. If null or empty, matches all log types.
          example:
          - INTEGRATION_IMPORT
          - JOB_EXECUTION
          items:
            description: Optional filter by log types. If null or empty, matches all log types.
            enum:
            - INTEGRATION_IMPORT
            - INTEGRATION_STATISTICS
            - JOB_EXECUTION
            - USER_ACTIVITY
            - SECURITY_EVENT
            example: '["INTEGRATION_IMPORT","JOB_EXECUTION"]'
            type: string
          type: array
        offset:
          description: Number of results to skip for pagination
          example: 0
          format: int32
          minimum: 0
          type: integer
        resourceFilters:
          default: []
          description: Optional resource filters. Multiple filters use OR logic. If null or empty, matches all resources the user has access to (requires system logs permission if no filters specified).
          example:
          - resourceId: int-123
            resourceType: INTEGRATION
          - resourceId: job-456
            resourceType: JOB
          items:
            $ref: '#/components/schemas/ResourceFilter'
          type: array
        searchQuery:
          description: Optional full-text search query for message content. Uses PostgreSQL's text search capabilities.
          example: failed import
          type: string
        startTime:
          description: Start of time range filter. Must be a valid ISO timestamp in UTC.
          example: '2024-01-01T00:00:00Z'
          format: date-time
          type: string
        statuses:
          default: []
          description: Optional filter by log statuses. If null or empty, matches all log statuses.
          example:
          - INFO
          - ERROR
          items:
            description: Optional filter by log statuses. If null or empty, matches all log statuses.
            enum:
            - INFO
            - WARNING
            - ERROR
            example: '["INFO","ERROR"]'
            type: string
          type: array
        userIds:
          default: []
          description: Optional filter by user IDs who triggered the activity. If null or empty, matches all users.
          example:
          - user123
          - user456
          items:
            description: Optional filter by user IDs who triggered the activity. If null or empty, matches all users.
            example: '["user123","user456"]'
            type: string
          type: array
      type: object
    Any:
      description: A value that can be a primitive (String or number), a list, or a map.
      example:
      - 12
      - a
      - b: 1
      - - 1
        - 2
        - 3
  securitySchemes:
    grepr-api-key:
      in: header
      name: GREPR-API-KEY
      type: apiKey
    grepr-oidc:
      bearerFormat: JWT
      openIdConnectUrl: https://grepr-prod.us.auth0.com/.well-known/openid-configuration
      type: openIdConnect
x-refined-from:
- grepr-openapi.json
- grepr.json
x-tagGroups:
- name: Integrations
  tags:
  - Grepr-hosted Data Warehouse Integration
  - External S3 Data Warehouse Integration
  - Datadog Integration
  - New Relic Integration
  - Splunk Integration
  - Sumo Logic Integration
  - OpenTelemetry Integration
- name: Pipelines
  tags:
  - Jobs
  - Templates
  - Datasets
  - Status Metrics
  - External Triggers
  - Job Actions
  - Triggers
- name: Pipeline Components
  tags:
  - Operations
  - Transforms
  - Sources
  - Sinks
- name: Administration
  tags:
  - Users
  - Teams
  - Roles
  - Permission
  - Invitations
  - Activity Logs
- name: Organization
  tags:
  - Organizations
  - Access Configuration
  - Grepr API Key
  - Service Accounts
  - Signup
- name: Query & Analysis
  tags:
  - Job Anomalies
  - Grok Parsing
  - Query Parsing
  - Validation
- name: System
  tags:
  - Manifest