---
title: "POST /entities/query/summarize"
method: POST
path: "/entities/query/summarize"
tags: ["Graph", "Entity"]
---

# POST /entities/query/summarize

`POST /entities/query/summarize`

## Headers

- `X-Authenticated-User-Actor-Id` string, uuid, required

## Request body

- SummarizeEntitiesParams
  - `filter` union, required
    - object
      - `all` Filter[], required
    - object
      - `any` Filter[], required
    - object
      - `not` Filter, required — recursive
    - object
      - `equal` FilterExpression[], required
        - union
          - PathExpression
            - `path` union[], required
              - …
          - ParameterExpression
            - `convert` object
              - …
            - `parameter` unknown, required
    - object
      - `notEqual` FilterExpression[], required
        - union
          - PathExpression
            - `path` union[], required
              - …
          - ParameterExpression
            - `convert` object
              - …
            - `parameter` unknown, required
    - object
      - `exists` PathExpression, required
        - `path` union[], required
          - union
            - 'baseUrl' | 'version' | 'versionedUrl' | 'webId' | 'title' | 'description' | 'type' | 'inheritsFrom' | 'children' | 'editionProvenance' | 'embedding' — A single token in a [`DataTypeQueryPath`].
            - 'baseUrl' | 'version' | 'versionedUrl' | 'webId' | 'title' | 'description' | 'editionProvenance' | 'dataTypes' | 'propertyTypes' | 'embedding' — A single token in a [`DataTypeQueryPath`].
            - 'baseUrl' | 'version' | 'versionedUrl' | 'webId' | 'title' | 'description' | 'properties' | 'required' | 'labelProperty' | 'icon' | 'editionProvenance' | 'links' | 'linkDestinations' | 'inheritsFrom' | 'children' | 'embedding' — A single token in a [`EntityTypeQueryPath`].
            - 'uuid' | 'editionId' | 'draftId' | 'archived' | 'webId' | 'type' | 'properties' | 'label' | 'createdById' | 'editionCreatedById' | 'createdAtTransactionTime' | 'createdAtDecisionTime' | 'provenance' | 'editionProvenance' | 'embedding' | 'incomingLinks' | 'outgoingLinks' | 'leftEntity' | 'rightEntity' — A single token in an [`EntityQueryPath`].
            - '*'
            - 'convert'
            - string
            - number
    - object
      - `greater` FilterExpression[]
        - union
          - PathExpression
            - `path` union[], required
              - …
          - ParameterExpression
            - `convert` object
              - …
            - `parameter` unknown, required
    - object
      - `greaterOrEqual` FilterExpression[]
        - union
          - PathExpression
            - `path` union[], required
              - …
          - ParameterExpression
            - `convert` object
              - …
            - `parameter` unknown, required
    - object
      - `less` FilterExpression[]
        - union
          - PathExpression
            - `path` union[], required
              - …
          - ParameterExpression
            - `convert` object
              - …
            - `parameter` unknown, required
    - object
      - `lessOrEqual` FilterExpression[]
        - union
          - PathExpression
            - `path` union[], required
              - …
          - ParameterExpression
            - `convert` object
              - …
            - `parameter` unknown, required
    - object
      - `startsWith` FilterExpression[], required
        - union
          - PathExpression
            - `path` union[], required
              - …
          - ParameterExpression
            - `convert` object
              - …
            - `parameter` unknown, required
    - object
      - `endsWith` FilterExpression[], required
        - union
          - PathExpression
            - `path` union[], required
              - …
          - ParameterExpression
            - `convert` object
              - …
            - `parameter` unknown, required
    - object
      - `containsSegment` FilterExpression[], required
        - union
          - PathExpression
            - `path` union[], required
              - …
          - ParameterExpression
            - `convert` object
              - …
            - `parameter` unknown, required
  - `includeCount` boolean
  - `includeCreatedByIds` boolean
  - `includeDrafts` boolean, required
  - `includeEditionCreatedByIds` boolean
  - `includeTypeIds` boolean
  - `includeTypeTitles` boolean
  - `includeWebIds` boolean
  - `temporalAxes` union, required — Defines the two possible combinations of pinned/variable temporal axes that are used in queries that return [`Subgraph`]s. The [`VariableTemporalAxisUnresolved`] is optionally bounded, in the absence of provided bounds an inclusive bound at the timestamp at point of resolving is assumed. [`Subgraph`]: crate::subgraph::Subgraph
    - object
      - `pinned` object, required
        - `axis` 'transactionTime', required — Time axis for the transaction time. This is used as the generic argument to time-related structs and can be used as tag value.
        - `timestamp` string, date-time, nullable, required
      - `variable` object, required
        - `axis` 'decisionTime', required — Time axis for the decision time. This is used as the generic argument to time-related structs and can be used as tag value.
        - `interval` UnresolvedRightBoundedTemporalInterval, required
          - `end` union, required
            - object
              - …
            - object
              - …
          - `start` union, required
            - object
              - …
            - object
              - …
            - object
              - …
    - object
      - `pinned` object, required
        - `axis` 'decisionTime', required — Time axis for the decision time. This is used as the generic argument to time-related structs and can be used as tag value.
        - `timestamp` string, date-time, nullable, required
      - `variable` object, required
        - `axis` 'transactionTime', required — Time axis for the transaction time. This is used as the generic argument to time-related structs and can be used as tag value.
        - `interval` UnresolvedRightBoundedTemporalInterval, required
          - `end` union, required
            - object
              - …
            - object
              - …
          - `start` union, required
            - object
              - …
            - object
              - …
            - object
              - …

## Response `200`

- SummarizeEntitiesResponse
  - `count` integer
  - `createdByIds` object
  - `editionCreatedByIds` object
  - `typeIds` object
  - `typeTitles` object
  - `webIds` object

## Other responses

- `422` — Provided query is invalid
- `500` — Store error occurred

---

[API](https://skmtc.dev/hashintel/apis/graph.md) · [All operations](https://skmtc.dev/hashintel/apis/graph/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hashintel/graph/revisions/ba95e69ddba8/schema)