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

# Grafo de relações

> As relações de um cliente (identificadores mascarados, empresas, objetos, agentes e sistemas) ou o mapa dos clientes mais conectados do espaço, para o Console.



## OpenAPI

````yaml openapi/pt/cell.json GET /v1/graph
openapi: 3.1.0
info:
  title: API de dados da Niadra
  version: '1'
  description: >-
    Escrita, contexto, histórico, objetos, identidade, privacidade e governança
    de um espaço. Cada espaço tem um endereço estável, com o espaço e a região
    no nome.
servers:
  - url: https://{space}.{region}.api.niadra.com
    variables:
      space:
        default: acme-prod
        description: O espaço, que vem na chave de fonte.
      region:
        default: us-east-2
        description: A região do espaço, que também vem na chave.
security: []
paths:
  /v1/graph:
    get:
      tags:
        - governance
      summary: Grafo de relações
      description: >-
        As relações de um cliente (`center`, `depth` 1 ou 2, até `limit` nós,
        150 por padrão) ou os clientes e empresas mais conectados do espaço
        entre os de atividade mais recente (`overview=1`, 100 por padrão). Um
        perfil apagado ou unido a outro não é encontrado.


        **Autenticação.** Token de pessoa do Console com o papel `security`,
        `integration` (ou admin), ou chave de fonte com o escopo `admin`.
      operationId: graph_v1_graph_get
      parameters:
        - in: query
          name: center
          required: false
          schema:
            anyOf:
              - format: uuid
                type: string
              - type: 'null'
            title: Center
        - in: query
          name: overview
          required: false
          schema:
            default: false
            title: Overview
            type: boolean
        - in: query
          name: depth
          required: false
          schema:
            default: 1
            maximum: 2
            minimum: 1
            title: Depth
            type: integer
        - in: query
          name: limit
          required: false
          schema:
            anyOf:
              - maximum: 300
                minimum: 1
                type: integer
              - type: 'null'
            title: Limit
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Graph'
          description: Resposta de sucesso.
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: O pedido não bate com o contrato.
      security:
        - sourceKey: []
        - personToken: []
components:
  schemas:
    Graph:
      additionalProperties: false
      properties:
        center:
          anyOf:
            - type: string
            - type: 'null'
          description: O perfil no centro do grafo; nulo no mapa do espaço.
          title: Center
        edges:
          items:
            $ref: '#/components/schemas/GraphEdge'
          title: Edges
          type: array
        generated_at:
          format: date-time
          title: Generated At
          type: string
        nodes:
          items:
            $ref: '#/components/schemas/GraphNode'
          title: Nodes
          type: array
        truncated:
          description: >-
            Se ficaram nós de fora: além do limite, os mais distantes primeiro
            (nunca o centro, os identificadores dele nem as empresas, parceiros
            e perfis parecidos ligados a ele antes de qualquer outro), ou os
            objetos de um cliente além dos 25 mais recentes.
          title: Truncated
          type: boolean
        withheld:
          description: >-
            Nós deixados de fora porque o papel de quem lê não pode vê-los:
            identificadores unidos por uma alegação que ninguém confirmou e
            objetos que a política nega.
          title: Withheld
          type: integer
      required:
        - center
        - nodes
        - edges
        - truncated
        - withheld
        - generated_at
      title: Graph
      type: object
    Problem:
      additionalProperties: false
      description: >-
        Detalhes do problema no formato da RFC 9457; `code` vem do catálogo de
        erros versionado.
      properties:
        code:
          title: Code
          type: string
        detail:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Detail
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Request Id
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          default: about:blank
          title: Type
          type: string
      required:
        - title
        - status
        - code
      title: Problem
      type: object
    GraphEdge:
      additionalProperties: false
      properties:
        from:
          description: O nó onde a relação começa.
          title: From
          type: string
        id:
          title: Id
          type: string
        kind:
          enum:
            - identifies
            - member_of
            - partner_of
            - parent_of
            - owns
            - relates_to
            - acted_on
            - talked_with
            - reported
            - handed_off
            - suggested_same
          title: Kind
          type: string
        meta:
          additionalProperties: true
          description: >-
            `identifies`: `strength` (strong ou weak), `weight`, `since`.
            `member_of` e `partner_of`: `role`, `since`. `parent_of`: `since`.
            `owns`: `role` (owner ou participant). `relates_to`: `relation`.
            `acted_on`: `count`, `last_at`, `operations`. `talked_with`:
            `count`, `last_at`, `channels`. `reported`: `count`, `last_at`.
            `handed_off`: `count`, `status`, `outcome`, `last_at`, `about` (o nó
            do cliente). `suggested_same`: `score`.
          title: Meta
          type: object
        to:
          title: To
          type: string
      required:
        - id
        - from
        - to
        - kind
      title: GraphEdge
      type: object
    GraphNode:
      additionalProperties: false
      properties:
        id:
          description: Opaco, e estável só dentro desta resposta.
          title: Id
          type: string
        kind:
          enum:
            - person
            - account
            - partner
            - handle
            - object
            - agent
            - system
          title: Kind
          type: string
        label:
          description: >-
            Um cliente ou uma empresa pelo pseudônimo, um identificador
            mascarado seja qual for o papel de quem lê, um objeto pelo tipo e
            pelo ID, um agente ou um sistema pelo nome da fonte.
          title: Label
          type: string
        meta:
          additionalProperties: true
          description: >-
            `hop`, a distância do centro (0 no centro; 0 em todo nó do mapa do
            espaço), e por tipo: de um cliente, `pseudonym`, `handles` e, quando
            as relações dele foram lidas, `objects_total` (quantos objetos ele
            tem ou de que participa; um grafo mostra os 25 mais recentes); de um
            identificador, `type`, `channel`, `weight`, `provisional` e
            `last_seen`; de um objeto, `type`, `namespace`, `external_id`,
            `state`, `state_label`, `masked` e `as_of`; de uma fonte, `channel`
            e `vendor`, ou do destino de um repasse, `target`. O mapa do espaço
            soma a cada cliente `links`, `objects`, `interactions` e `score`.
          title: Meta
          type: object
        ref:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            O ID real a que o Console leva: o perfil, o objeto de negócio ou a
            fonte. Nulo para um identificador e para o destino de um repasse que
            não é uma fonte.
          title: Ref
      required:
        - id
        - kind
        - label
        - ref
      title: GraphNode
      type: object
  securitySchemes:
    sourceKey:
      type: http
      scheme: bearer
      description: nia_sk_...
    personToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.