# Pyramid Analytics

> Decision intelligence platform unifying data preparation, business analytics and AI-assisted
> insight generation. Deployed onto the customer's own infrastructure ("Pyramid Deployed") or
> hosted per-tenant by Pyramid ("Pyramid Managed"). Generated by API Evangelist from Pyramid's
> published documentation on 2026-08-26 — Pyramid does not serve an llms.txt of its own
> (https://www.pyramidanalytics.com/llms.txt and https://help.pyramidanalytics.com/llms.txt both
> return HTTP 404).

## What an agent needs to know first

- **There is no vendor-hosted API.** The base URL is the CUSTOMER'S OWN Pyramid server:
  `https://{pyramid-server}/API3/`. Pyramid's own examples use `http://mysite.com/api3/` and
  `http://Your.Server.URL/API3/`. `api.pyramidanalytics.com` does not resolve.
- **Everything is POST.** Every one of the 234 documented API 3.0 methods states "REST APIs via
  POST actions only" — including read-only methods like `access/getMe`. The HTTP verb carries no
  safety signal; consult the operation, not the method.
- **The URL is the method name**, not a resource: `/API3/<section>/<methodName>`.
- **Auth is a `paToken` HTTP header**, holding a base64 token minted by
  `/API3/authentication/authenticateUser`. Not OAuth, no scopes.
- **REST API access is administrative only.** Pyramid states: "All REST API calls are limited to
  administrative users only." Treat any token you are handed as high-authority.
- **No OpenAPI is published publicly.** Pyramid generates its Swagger (OpenAPI 2.0) definition
  inside each installation. There is no `openapi.json` on any Pyramid-controlled host.
- **`content/purgeContentItems` is irreversible** — "Purged items can never be restored."
  `content/deleteItems` is a soft delete and IS reversible via `content/restoreDeletedItems`, but
  no retention window is published.
- **No rate limits are documented** and no `RateLimit-*` / `Retry-After` headers are returned.

## API sections (API 3.0, 234 documented methods)

- /API3/authentication (10) — authenticateUser, authenticateUserByToken, and SAML / OpenID /
  Windows variants, each with an Embed twin for cross-domain embedding
- /API3/access (67) — users, roles, tenants, profiles, licences, IDP search and provisioning
- /API3/content (49) — items, folders, tags, hubs, favorites, import/export, soft delete + restore
- /API3/dataSources (75) — data servers, databases, semantic models, master flows, data security
  overlays, Xtender
- /API3/tasks (16) — tasks, schedules, executions, outputs, suspend/resume
- /API3/analytics (8) — extractQueryResult, extractNlpQueryResult, getParameterElements, formulas, lists
- /API3/themes (5) — apply, import, export, list
- /API3/notification (4) — indicators and server metrics

## Documentation

- [API Overview](https://help.pyramidanalytics.com/Content/Root/developer/reference/APIs/API%20Overview.htm): the four API frameworks — Main (REST/SDK), Custom Visual, Workflow, Embed
- [Main API and SDKs](https://help.pyramidanalytics.com/Content/Root/developer/reference/APIs/REST%20API/APIs%20and%20SDKs.htm): version map and the method indices
- [Using REST](https://help.pyramidanalytics.com/Content/Root/developer/reference/APIs/REST%20API/Using%20REST.htm): the POST model, the paToken header, response semantics
- [Authentication APIs Overview](https://help.pyramidanalytics.com/Content/Root/developer/reference/APIs/REST%20API/Authentication%20APIs.htm): client, API and embed login flows
- [Using SDKs](https://help.pyramidanalytics.com/Content/Root/developer/reference/APIs/REST%20API/Using%20SDKs.htm)
- [REST API HTTP Status Codes](https://help.pyramidanalytics.com/Content/Root/developer/reference/APIs/REST%20API/HTTP%20Status%20Codes.htm)
- [Embed API overview](https://help.pyramidanalytics.com/Content/Root/developer/reference/Extensibility/Embedding/General%20Embed/EmbedAPI_v1_Overview.htm)
- [Versions and Releases](https://help.pyramidanalytics.com/Content/Root/Guides/general/Release%20Framework.htm): LTS/FVS tracks and the dated end-of-support matrix
- [Version History](https://help.pyramidanalytics.com/Content/Root/general/Version%20History%20Overview.htm)

## SDKs

Official, Swagger-generated, in Java (`com.pyramidanalytics`), C#, JavaScript/TypeScript, Python
and PHP — available from API version 3 (release 2023.10). **None are on a public registry.**
Pyramid states: "All SDK libraries are NOT currently deployed to public repositories." They are
downloaded from the authenticated customer portal at https://customers.pyramidanalytics.com/ and
installed from a local registry the customer stands up. Verified absent from Maven Central, npm,
PyPI, NuGet and Packagist on 2026-08-26.

## Other surfaces

- **OData Feed** — any Pyramid discovery result set can be emitted as an OData URL or snippet,
  consumable from Excel, Power BI and other OData-compliant tools. Separately licensed.
- **Webhooks** — outbound distribution channels (Teams, Slack, general URL) that receive scheduled
  publications, alerts and subscriptions. Enterprise Edition only. No payload schema, event-type
  registry or signature scheme is published.
- **MCP** — none. Pyramid publishes no Model Context Protocol server.
- **A2A agent card** — none served on any host.

## Company

- [Website](https://www.pyramidanalytics.com/)
- [Pricing](https://www.pyramidanalytics.com/decision-intelligence-platform/get-pricing/) — quote only, no published tiers
- [Community forum](https://community.pyramidanalytics.com/)
- [Support](https://www.pyramidanalytics.com/company/support/)
- [Blog](https://www.pyramidanalytics.com/resources/blog/)
- [GitHub](https://github.com/Pyramid-Analytics) — one public repo (aws-cloudformation)
- [Terms of Use](https://www.pyramidanalytics.com/terms-of-use/) · [Privacy Policy](https://www.pyramidanalytics.com/privacy-policy/)