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

# Monthly activity heatmap aggregated by party document



## OpenAPI

````yaml /api-reference/openapi.json get /v2/lawsuits/activity-heatmap
openapi: 3.1.0
info:
  title: Base39 API
  description: Base39 API
  version: 1.0.0
  contact:
    name: Base39 Team
    url: https://base39.com.br
    email: suporte@base39.com.br
  termsOfService: https://base39.com.br/termos
  license:
    name: Proprietary
    url: https://base39.com.br/termos
servers:
  - url: http://localhost:3000
    description: Local
  - url: https://api.dev.base39.cloud
    description: Development
  - url: https://api.base39.com.br
    description: Production
security:
  - OAuth2: []
tags:
  - name: pages
    description: Profiles and reports pages
  - name: pipelines
    description: Pipeline boards (kanban) of pages
  - name: blocks
    description: Blocks operations
  - name: search
    description: Search across content
  - name: targets
    description: Lookup targets via datasets
  - name: CognitoTriggers
    description: Cognito triggers
paths:
  /v2/lawsuits/activity-heatmap:
    get:
      tags:
        - lawsuits
      summary: Monthly activity heatmap aggregated by party document
      operationId: lawsuits_get_activity_heatmap
      parameters:
        - name: expand
          required: false
          in: query
          description: >-
            Comma-separated fields to expand. Supports selection with brackets
            (e.g., "createdBy,updatedBy" or "targets.company[icon,tradeName]").
          schema:
            example: createdBy
            type: string
        - name: page_size
          required: false
          in: query
          description: Number of items to return per page
          schema:
            minimum: 1
            maximum: 100
            default: 20
            example: 100
            type: number
        - name: start_cursor
          required: false
          in: query
          description: >-
            Opaque cursor for pagination. Use the next_cursor from previous
            response.
          schema:
            example: >-
              eyJjcmVhdGVkX3RpbWUiOiIyMDI0LTExLTE1VDEwOjAwOjAwLjAwMFoiLCJpZCI6InBhZ2VfYWJjMTIzIn0=
            type: string
        - name: filter
          required: true
          in: query
          description: 'Required exact filter. Supported field: `parties.document`.'
          schema:
            example: parties.document:"61969404000182"
            type: string
      responses:
        '200':
          description: Pre-aggregated heatmap payload
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/LawsuitActivityHeatmapOutput'
        '400':
          description: Invalid filter or document
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
        '401':
          description: Unauthorized
components:
  schemas:
    LawsuitActivityHeatmapOutput:
      type: object
      properties:
        entityType:
          type: string
          enum:
            - company
            - person
        document:
          type: string
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/LawsuitActivityHeatmapBucketOutput'
        totalMovements:
          type: number
        maxCount:
          type: number
        firstMonth:
          type: string
          nullable: true
        lastMonth:
          type: string
          nullable: true
      required:
        - entityType
        - document
        - buckets
        - totalMovements
        - maxCount
    ProblemDetailsDto:
      type: object
      properties:
        type:
          type: string
          example: about:blank
        title:
          type: string
          example: Not Found
        status:
          type: number
          example: 404
        detail:
          type: string
          example: Protests not found for document
        instance:
          type: string
          example: /v2/entities/61969404000182/protests
        request_id:
          type: string
          example: req_123
      required:
        - type
        - title
        - status
        - detail
        - instance
        - request_id
    LawsuitActivityHeatmapBucketOutput:
      type: object
      properties:
        monthKey:
          type: string
          description: YYYY-MM calendar month key.
        year:
          type: number
        month:
          type: number
          description: 1-indexed calendar month (1 = January).
        total:
          type: number
        byType:
          $ref: '#/components/schemas/LawsuitActivityHeatmapByTypeOutput'
      required:
        - monthKey
        - year
        - month
        - total
        - byType
    LawsuitActivityHeatmapByTypeOutput:
      type: object
      properties:
        update:
          type: number
        petition:
          type: number
        decision:
          type: number
        movement:
          type: number
      required:
        - update
        - petition
        - decision
        - movement
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://id.local.base39.cloud/oauth2/authorize
          tokenUrl: https://id.local.base39.cloud/oauth2/token
          scopes:
            profile: Read user profile
            email: Read user email
            openid: OpenID authentication
      description: OAuth2 Authorization Code flow

````