Revenue per month, recurring revenue, what is owed and the top customers
GET
/products/{productId}/insights/overview
const url = 'https://api.motenya.app/v1/products/example/insights/overview';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.motenya.app/v1/products/example/insights/overview \ --header 'Authorization: Bearer <token>'Requires crm:read.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”productId
required
string
Query Parameters
Section titled “Query Parameters”months
Months of history, 1–36 (default 12).
integer
Months of history, 1–36 (default 12).
Responses
Section titled “Responses”Success
Media typeapplication/json
Per currency, never converted. Paid means not canceled or refunded, and paid or with no payment status.
object
revenue
required
Array<object>
object
month
required
“YYYY-MM”, UTC.
string
currency
required
string
amount
required
string
lifetimeRevenue
required
Array<object>
object
currency
required
string
amount
required
string
outstanding
required
Array<object>
object
currency
required
string
amount
required
string
overdue
required
Array<object>
object
currency
required
string
amount
required
string
mrr
required
Array<object>
object
currency
required
string
amount
required
string
activeSubscriptions
required
integer
subscriptionMovements
required
Array<object>
object
month
required
string
started
required
integer
canceled
required
integer
topCustomers
required
Array<object>
object
client
required
object
id
required
string
name
required
string | null
email
required
string | null
contact
required
object
id
required
string
name
required
string | null
email
required
string | null
currency
required
string
amount
required
string
orderCount
required
integer
key
additional properties
Example generated
{ "revenue": [ { "month": "example", "currency": "example", "amount": "example" } ], "lifetimeRevenue": [ { "currency": "example", "amount": "example" } ], "outstanding": [ { "currency": "example", "amount": "example" } ], "overdue": [ { "currency": "example", "amount": "example" } ], "mrr": [ { "currency": "example", "amount": "example" } ], "activeSubscriptions": 1, "subscriptionMovements": [ { "month": "example", "started": 1, "canceled": 1 } ], "topCustomers": [ { "client": { "id": "example", "name": "example", "email": "example" }, "contact": { "id": "example", "name": "example", "email": "example" }, "currency": "example", "amount": "example", "orderCount": 1 } ]}Invalid request
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string
Example
{ "error": { "code": "SLUG_TAKEN" }}Missing, invalid, revoked or expired API key
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string
Example
{ "error": { "code": "SLUG_TAKEN" }}Missing scope, API turned off, published article without publish scope, or account suspended
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string
Example
{ "error": { "code": "SLUG_TAKEN" }}Not found, or outside the knowledge bases this key may use
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string
Example
{ "error": { "code": "SLUG_TAKEN" }}Slug or translation already exists
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string
Example
{ "error": { "code": "SLUG_TAKEN" }}Rejected by validation (e.g. unknown language or category)
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string
Example
{ "error": { "code": "SLUG_TAKEN" }}Rate limited; see Retry-After
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string
Example
{ "error": { "code": "SLUG_TAKEN" }}Internal error