Pular para o conteúdo principal

API — Sysadmin — dashboard

Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.


GET /api/sysadmin/tenants

List Tenants With Stats

Parametros:

NomeTipoObrigatorioDescricao
pageintegerNao
page_sizeintegerNao
searchstringNao
planstringNao
sort_bystringNao
sort_orderstringNao

Exemplo resposta (200):

{
"items": [
"..."
],
"total": 0,
"page": 0,
"page_size": 0,
"pages": 0
}

Erros possiveis: 422 Validation Error


PUT /api/sysadmin/tenants/{tenant_id}

Update Tenant

Parametros:

NomeTipoObrigatorioDescricao
tenant_idintegerSim

Exemplo pedido:

{}

Exemplo resposta (200):

{}

Erros possiveis: 422 Validation Error


DELETE /api/sysadmin/tenants/{tenant_id}

Delete Tenant

Parametros:

NomeTipoObrigatorioDescricao
tenant_idintegerSim

Exemplo resposta (200):

{}

Erros possiveis: 422 Validation Error


PUT /api/sysadmin/tenants/{tenant_id}/activate

Activate Tenant

Parametros:

NomeTipoObrigatorioDescricao
tenant_idintegerSim

Exemplo resposta (200):

{}

Erros possiveis: 422 Validation Error


PUT /api/sysadmin/tenants/{tenant_id}/suspend

Suspend Tenant

Parametros:

NomeTipoObrigatorioDescricao
tenant_idintegerSim

Exemplo resposta (200):

{}

Erros possiveis: 422 Validation Error


GET /api/sysadmin/dashboard

Get Platform Dashboard

Exemplo resposta (200):

{
"total_tenants": 0,
"active_tenants": 0,
"inactive_tenants": 0,
"total_revenue": 0,
"total_orders": 0,
"orders_this_month": 0,
"new_tenants_this_month": 0,
"mrr": 0,
"revenue_growth_pct": 0,
"plan_distribution": {
"starter": 0,
"business": 0,
"professional": 0,
"enterprise": 0
}
}

GET /api/sysadmin/tenants/{tenant_id}/detail

Get Tenant Detail With Stats

Parametros:

NomeTipoObrigatorioDescricao
tenant_idintegerSim

Exemplo resposta (200):

{
"id": 0,
"name": "string",
"slug": "string",
"domain": null,
"custom_domain": null,
"plan": "string",
"status": "string",
"is_active": true,
"is_demo": true,
"template_id": null,
"products_count": 0,
"orders_count": 0,
"revenue": 0,
"customers_count": 0,
"branding_primary_color": null,
"branding_secondary_color": null,
"branding_accent_color": null,
"branding_logo_url": null,
"branding_tagline": null,
"email": null,
"phone": null,
"business_name": null,
"created_at": null,
"updated_at": null
}

Erros possiveis: 422 Validation Error


PUT /api/sysadmin/tenants/{tenant_id}/stripe-mode

Set Stripe Mode

Parametros:

NomeTipoObrigatorioDescricao
tenant_idintegerSim

Exemplo pedido:

{}

Exemplo resposta (200):

{}

Erros possiveis: 422 Validation Error


PUT /api/sysadmin/tenants/{tenant_id}/stripe-connect

Set Stripe Connect

Parametros:

NomeTipoObrigatorioDescricao
tenant_idintegerSim

Exemplo pedido:

{}

Exemplo resposta (200):

{}

Erros possiveis: 422 Validation Error


PUT /api/sysadmin/tenants/{tenant_id}/moloni

Set Moloni Config

Parametros:

NomeTipoObrigatorioDescricao
tenant_idintegerSim

Exemplo pedido:

{}

Exemplo resposta (200):

{}

Erros possiveis: 422 Validation Error


GET /api/sysadmin/tenants/{tenant_id}/metrics

Get Tenant Metrics

Parametros:

NomeTipoObrigatorioDescricao
tenant_idintegerSim

Exemplo resposta (200):

{}

Erros possiveis: 422 Validation Error


GET /api/sysadmin/tenants/{tenant_id}/health

Get Tenant Health

Parametros:

NomeTipoObrigatorioDescricao
tenant_idintegerSim

Exemplo resposta (200):

{}

Erros possiveis: 422 Validation Error


GET /api/sysadmin/tenants/{tenant_id}/users

List Tenant Users

Parametros:

NomeTipoObrigatorioDescricao
tenant_idintegerSim

Exemplo resposta (200):

[{
"id": 0,
"email": "string",
"first_name": "string",
"last_name": "string",
"role": "string",
"is_active": true,
"last_login_at": null,
"created_at": null
}]

Erros possiveis: 422 Validation Error


Documentacao gerada automaticamente.