Set KPIs

Authorizations:
Request Body schema: application/json

The /set_kpis endpoint is used to set product-level KPIs for individual users. These are aggregated up to form the KPI metrics shown on Corrily's dashboard.

user_id
required
string

Unique user identifier

product_id
required
string

Unique product identifier

status
string
Enum: "trialing" "active" "canceled" "transitioned"

The subscription status.

subscription_amount
number

The subscription amount.

revenue_received
number

An amount of revenue received.

revenue_refunded
number

An amount of revenue refunded.

Array of objects (KPI)

A list of KPI objects.

Responses

Request samples

Content type
application/json
{
  • "user_id": "user_001",
  • "product_id": "monthly_plan",
  • "status": "trialing",
  • "subscription_amount": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string"
}
Copyright © Corrily 2020. All right reserved.