Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Feedback Management

Push email-delivery stats for a feedback form

<Warning> The Feedback Management API is currently in **BETA**, therefore the following endpoints are subject to modification, given a **2 week notice**.

If you are planning to use any of them, please notify us so we will be able to keep you informed about upcoming changes. </Warning>

This endpoint lets you push one day of email-delivery funnel metrics (sent, delivered, opened, clicked, bounced) for a feedback form and business, typically reported by your Email Service Provider (ESP).

It upserts on (feedback_form_id, business_id, date): sent and clicked always overwrite the row, while the optional metrics (processed, delivered, opened, bounced) keep their previous value when omitted or null, defaulting to 0 only on a brand-new row.

Rows created here are always stored with source: external, and feed the survey.sent, survey.delivered, survey.opened, survey.clicked and survey.error_bounces analytics metrics.

post/feedback/feedback_form/stats

Request body

feedback_form_idstring required

The unique identifier of the form

business_idstring required

Business id

datestring date required

Day these metrics apply to

sentinteger required

Number of survey emails sent

clickedinteger required

Number of survey link clicks (from the email)

processedinteger nullable

Number of survey emails accepted for delivery by the ESP. Omit or send null to leave unchanged.

deliveredinteger nullable

Number of survey emails successfully delivered. Omit or send null to leave unchanged.

openedinteger nullable

Number of survey emails opened. Omit or send null to leave unchanged.

bouncedinteger nullable

Number of survey emails that bounced. Omit or send null to leave unchanged.

Example request

{
  "feedback_form_id": "674d791c13c9d976e20001b1",
  "business_id": "5409c35a97bbc544d8e26737",
  "date": "2026-06-01",
  "sent": 100,
  "clicked": 10,
  "processed": 95,
  "delivered": 90,
  "opened": 50,
  "bounced": 5
}

Response

OK

feedback_form_idstring

The unique identifier of the form

business_idstring

Business id

datestring date

Day these metrics apply to

source'external' | 'internal'

Origin of the emailing volume.

Always external for rows created through this endpoint (i.e. reported by your ESP).

org_idinteger

The organization ID the feedback form belongs to

sentinteger

Number of survey emails sent

processedinteger

Number of survey emails accepted for delivery by the ESP

deliveredinteger

Number of survey emails successfully delivered

openedinteger

Number of survey emails opened

clickedinteger

Number of survey link clicks (from the email)

error_bouncesinteger

Number of survey emails that bounced

Example response

{
  "feedback_form_id": "674d791c13c9d976e20001b1",
  "business_id": "5409c35a97bbc544d8e26737",
  "date": "2026-06-01",
  "source": "external",
  "org_id": 42,
  "sent": 100,
  "processed": 95,
  "delivered": 90,
  "opened": 50,
  "clicked": 10,
  "error_bounces": 5
}