# Obter resumo da comunidade

URL canônica: https://sosoapi.ai/pt-br/docs/api/community-engagement-api-operations-summary

Contrato: sha256:563d2d581da0ad29

Consulte o resumo de operações da comunidade de um Workspace: modo da lane, backlog, tempos de resposta, status das ações e taxas do provedor.

POST /community-engagement-api/operations/summary

## Autenticação e permissões

- **Classes de credenciais aceitas:** user_session, delegated_oauth, personal_access_token

- **Capacidade delegada:** agent:engage

- **Função mínima no workspace:** viewer

- **Escopo de acesso:** Recursos que este usuário tem autorização para acessar

- **Consentimento para todos os workspaces obrigatório:** Não

- **Altera o estado:** Não

- **Quando a operação estiver concluída:** synchronous_http_response

Um token só pode usar os direitos do seu proprietário. Cada requisição verifica participação no workspace, propriedade de recursos, workspaces selecionados e capacidades concedidas. Os perfis core e full mudam as ferramentas exibidas; não concedem acesso.

## Campos da requisição

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}
```

## Resposta e conclusão

Códigos HTTP de sucesso: 200

Uma resposta HTTP bem-sucedida pode significar que uma requisição foi aceita, não concluída. Para trabalho em segundo plano, salve o ID retornado e consulte a mesma operação até terminar. Um post agendado ou aceito só está publicado quando a plataforma confirma; um timeout do cliente não comprova o resultado.

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contract_version": {
      "type": "string",
      "const": "community-engagement/v1"
    },
    "summary": {
      "type": "object",
      "properties": {
        "lane_mode": {
          "type": "string",
          "enum": [
            "off",
            "canary",
            "on"
          ]
        },
        "backlog": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "response_time_seconds": {
          "type": "object",
          "properties": {
            "median": {
              "anyOf": [
                {
                  "type": "number"
                },
                {
                  "type": "null"
                }
              ]
            },
            "p95": {
              "anyOf": [
                {
                  "type": "number"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "median",
            "p95"
          ]
        },
        "action_statuses": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "provider_rate": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "partial_failure_count": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "known_common_dependencies": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "lane_mode",
        "backlog",
        "response_time_seconds",
        "action_statuses",
        "provider_rate",
        "partial_failure_count",
        "known_common_dependencies"
      ]
    }
  },
  "required": [
    "contract_version",
    "summary"
  ]
}
```

## Erros e repetições seguras

Confira o status HTTP e o corpo da resposta. Um erro de validação 400 pode conter ZodError; erros do handler usam os campos error, message e code. Guarde request_id ou x-request-id para diagnóstico, sem credenciais. Corrija erros de acesso 401/403 antes de tentar novamente e siga Retry-After para 429. Se uma gravação for incerta ou retornar 5xx, consulte primeiro o resultado existente. Reutilize uma chave de idempotência somente quando houver suporte; o comportamento de repetição varia por operação e não garante entrega exatamente uma vez.

## Exemplos

Estes exemplos usam valores fictícios verificados conforme os schemas. Substitua os IDs por aqueles que você tem autorização para usar, a mídia por ativos prontos e as datas pelo horário de publicação confirmado. Confira a elegibilidade da conta antes de enviar uma gravação. Esta página não envia requisições de API.

Defina SOSOAPI_ACCESS_TOKEN no servidor como uma credencial aceita por esta operação e mantenha-a fora do código do navegador. Para agentes, use sosoapi auth login para entrar pelo navegador e deixe a CLI renovar suas credenciais.

request.json

```json
{
  "workspace_id": "11111111-1111-4111-8111-111111111111"
}
```

cURL

```bash
curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/community-engagement-api/operations/summary" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json
```

JavaScript

```js
// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/community-engagement-api/operations/summary", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.
```

CLI

```bash
npx sosoapi api post /community-engagement-api/operations/summary < request.json
```

Exemplo de resposta sintética

```json
{
  "contract_version": "community-engagement/v1",
  "summary": {
    "lane_mode": "off",
    "backlog": {},
    "response_time_seconds": {
      "median": null,
      "p95": null
    },
    "action_statuses": {},
    "provider_rate": {},
    "partial_failure_count": 0,
    "known_common_dependencies": []
  }
}
```

## Ferramentas e guias relacionados

MCP: sosoapi_get_community_engagement_summary

[Referência da API](https://sosoapi.ai/pt-br/docs/api)