GET /api/partner/v1 | Who the key is: the partner, whether it is a sandbox, the key's scopes, and where everything is. | any valid key | | |
GET /api/partner/v1/clients | The partner's clients, each with its summary line: the figures that client's own latest review states, when it has one. | clients:read | | |
POST /api/partner/v1/clients | Make a client workspace: its own workspace, its currency and fiscal calendar, the partner's tag. The answer is the client with its reference. A sandbox key makes a workspace of synthetic data. Example: | clients:write | | |
GET /api/partner/v1/clients/{client} | One client: its names, its workspace, its licence and its summary line, and whether the client has an admin of its own yet (client_admins, and admin_invited: the addresses invited to become one that have not accepted). | clients:read | yes | |
POST /api/partner/v1/clients/{client}/admins | Invite the client's first admin: the person at the retailer who decides for its workspace (whether its partner may publish to its readers, whether the partner's people sign in, a move to another channel). | clients:write | yes | workspace |
GET /api/partner/v1/clients/{client}/data/health | The client's data health: what arrived, what is late or missing, and what to do. | data:read | yes | outbound_api |
GET /api/partner/v1/clients/{client}/data/submissions/{submission_id} | What became of a file sent: its status, counts, problems and what the delivery gate checked. | data:read | yes | inbound_api |
POST /api/partner/v1/clients/{client}/data/{kind} | Send one file of a dataset for the client: the same as POST /api/v1/inbound/submissions/{kind} in the client's workspace, with its validation, delivery gate, control totals and loader. 201 loaded, 202 held for a decision, 200 the same content was received before, 422 refused, 409 a reused Idempotency-Key. Example: | data:write | yes | inbound_api |
DELETE /api/partner/v1/clients/{client}/embed/sessions | End the client's embedded sessions now: one person's (when they sign out of your application) or all of them. | embed:create | yes | workspace |
POST /api/partner/v1/clients/{client}/embed/tokens | An embed token: one person of yours reads the client's review, Outlook, findings and This quarter inside your page. Signed, single use, minutes long, bound to one of your embed origins. Mint one per page load, on your server, and put url in an iframe on that origin. Recorded in the client's audit log. Example: | embed:create | yes | explain |
PUT /api/partner/v1/clients/{client}/licence | Give the client another tier, one the wholesale agreement allows. Recorded in the client's audit log, the partner's log and the licence log. | clients:write | yes | |
GET /api/partner/v1/clients/{client}/outlook | The client's Outlook: the weeks ahead by cause against the client's plan or forecast, each item with its range and basis, the records on file with no amount, and the planners' decisions. | results:read | yes | explain |
GET /api/partner/v1/clients/{client}/period-review | The client's period review: sales by category against the plan's own figure for the period and last year, units and average unit retail, the weekly reviews' sized causes added up, events on file and what is still open. | results:read | yes | explain |
GET /api/partner/v1/clients/{client}/period-review/document/{fmt} | The client's period review as a file: pptx, docx or pdf. | results:read | yes | act_documents |
GET /api/partner/v1/clients/{client}/period-review/periods | The client's periods (months or fiscal periods of its calendar) that hold sales on file, newest first, each closed or to date. The fields are those of GET /api/v1/period-review/periods. | results:read | yes | explain |
POST /api/partner/v1/clients/{client}/references | Load a plan or forecast for the client: the same as POST /api/v1/outlook/references in the client's workspace. Kept as loaded, the original plan and every later forecast apart; a plan by period keeps its open-to-buy working, which the position against the plan reads. | data:write | yes | explain |
POST /api/partner/v1/clients/{client}/references/preview | What a plan file would load as for the client, and nothing written: the same answer as POST /api/v1/outlook/references/preview in the client's workspace. | data:write | yes | explain |
GET /api/partner/v1/clients/{client}/reviews/latest | The client's latest review, published or not: the three-part statement, the commentary as it stands and its status (draft or published). The fields are those of GET /api/v1/outbound/reviews/{week_start}. | results:read | yes | outbound_api |
GET /api/partner/v1/clients/{client}/reviews/{week_start} | One week's review of the client, published or not. | results:read | yes | outbound_api |
GET /api/partner/v1/clients/{client}/reviews/{week_start}/document/{fmt} | The client's review of a week as a file: docx (Word), pdf or pptx (PowerPoint), rendered on the server from the same document the app sends and shares. | results:read | yes | act_documents |
GET /api/partner/v1/clients/{client}/reviews/{week_start}/findings | The findings of a week's review, each with its evidence, as the outbound API states them. | results:read | yes | outbound_api |
POST /api/partner/v1/clients/{client}/reviews/{week_start}/publish | Publish the client's review of a week: the client's readers see it, and review.published is sent. Publishing a review that is published already changes nothing. Recorded in the client's audit log with the partner key as the actor. | reviews:publish | yes | explain |
POST /api/partner/v1/clients/{client}/runs | Produce the client's review of a week, from the data on file, and answer when it has finished (201). The review is a draft until it is published. review.produced is sent to the client's webhooks. | runs:write | yes | explain |
GET /api/partner/v1/clients/{client}/summary | The client's summary line, worked out now from its latest review: sales against plan, what recorded causes explain, what is not explained, the findings, Outlook decisions due, when data last loaded and how the latest run ended. | results:read | yes | outbound_api |
GET /api/partner/v1/clients/{client}/webhooks | The client's webhooks this partner added, the events there are, and how deliveries are retried. | webhooks:manage | yes | workspace |
POST /api/partner/v1/clients/{client}/webhooks | Add a webhook for the client. The answer carries the signing secret, once: store it. With an Idempotency-Key, a repeat answers the same webhook without its secret. | webhooks:manage | yes | webhooks |
DELETE /api/partner/v1/clients/{client}/webhooks/{webhook_id} | Remove webhook | webhooks:manage | yes | webhooks |
PATCH /api/partner/v1/clients/{client}/webhooks/{webhook_id} | Change webhook | webhooks:manage | yes | webhooks |
GET /api/partner/v1/clients/{client}/webhooks/{webhook_id}/deliveries | The delivery log: every event queued, its attempts, the last status code and when the next attempt is due. | webhooks:manage | yes | webhooks |
POST /api/partner/v1/clients/{client}/webhooks/{webhook_id}/deliveries/{delivery_id}/replay | Queue a delivery that failed or was given up on to be sent again, with the same body and the same delivery id. | webhooks:manage | yes | webhooks |
POST /api/partner/v1/clients/{client}/webhooks/{webhook_id}/secret | A new signing secret, shown once. The old one stops signing at once. | webhooks:manage | yes | webhooks |
POST /api/partner/v1/clients/{client}/webhooks/{webhook_id}/test | Send one signed test delivery now and say how it went. It appears in the delivery log. | webhooks:manage | yes | webhooks |
GET /api/partner/v1/licences | The partner's wholesale agreement and its pool: size, allocated, available, beyond the pool; the tiers a client may be given; each client's tier, state and end date; the warnings now (pool nearly full, agreement ending) and the notices sent. Counts and terms only: what the partner pays is in its signed contract. | clients:read | | |
GET /api/partner/v1/usage | Usage per client and calendar month: rows loaded, reviews produced, review texts the AI writer wrote, documents generated. Counts only. | clients:read | | |