Skip to main content
POST
Push email-delivery stats for a feedback form

Authorizations

x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Body

application/json
feedback_form_id
string
required

The unique identifier of the form

Example:

"674d791c13c9d976e20001b1"

business_id
string
required

Business id

Example:

"5409c35a97bbc544d8e26737"

date
string<date>
required

Day these metrics apply to

Example:

"2026-06-01"

sent
integer
required

Number of survey emails sent

Required range: x >= 0
Example:

100

clicked
integer
required

Number of survey link clicks (from the email)

Required range: x >= 0
Example:

10

processed
integer | null

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

Required range: x >= 0
Example:

95

delivered
integer | null

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

Required range: x >= 0
Example:

90

opened
integer | null

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

Required range: x >= 0
Example:

50

bounced
integer | null

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

Required range: x >= 0
Example:

5

Response

OK

One day of email-delivery funnel metrics for a (feedback_form, business) pair.

feedback_form_id
string

The unique identifier of the form

Example:

"674d791c13c9d976e20001b1"

business_id
string

Business id

Example:

"5409c35a97bbc544d8e26737"

date
string<date>

Day these metrics apply to

Example:

"2026-06-01"

source
enum<string>

Origin of the emailing volume.

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

Available options:
external,
internal
Example:

"external"

org_id
integer

The organization ID the feedback form belongs to

Example:

42

sent
integer

Number of survey emails sent

Required range: x >= 0
Example:

100

processed
integer

Number of survey emails accepted for delivery by the ESP

Required range: x >= 0
Example:

95

delivered
integer

Number of survey emails successfully delivered

Required range: x >= 0
Example:

90

opened
integer

Number of survey emails opened

Required range: x >= 0
Example:

50

clicked
integer

Number of survey link clicks (from the email)

Required range: x >= 0
Example:

10

error_bounces
integer

Number of survey emails that bounced

Required range: x >= 0
Example:

5