MANSOQ Knowledge
← Technical API reference

Backend resource · STATIC DECLARATIONS

Analytics API reference · mansoq-analytics-plug

Static source contract for Analytics: 7 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Declared route and availability

This resource is declared in mansoq-analytics-plug at /api/{installed_plugin_prefix}/config/. plugin/local mount; actual prefix and enablement require deployment verification A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Operation map

Method Path Action Evidence
GET /api/{installed_plugin_prefix}/config/ list declared/inherited method
POST /api/{installed_plugin_prefix}/config/ create declared/inherited method
GET /api/{installed_plugin_prefix}/config/{external_id}/ retrieve declared/inherited method
PUT /api/{installed_plugin_prefix}/config/{external_id}/ update declared/inherited method
PATCH /api/{installed_plugin_prefix}/config/{external_id}/ partial_update declared/inherited method
DELETE /api/{installed_plugin_prefix}/config/{external_id}/ destroy declared/inherited method
POST /api/{installed_plugin_prefix}/config/{external_id}/generate_analytics_url/ generate_analytics_url @action declaration

list · GET

GET /api/{installed_plugin_prefix}/config/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true

response: BaseAnalyticsResource. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 | None false No extra constraint extracted
name str true No extra constraint extracted
description str | None true No extra constraint extracted
metadata dict | None true No extra constraint extracted
handler str true No extra constraint extracted
handler_args dict true No extra constraint extracted
context_type AnalyticsContexts true No extra constraint extracted
context_mapping dict | None true No extra constraint extracted

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

create · POST

POST /api/{installed_plugin_prefix}/config/ — action create. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
body form_submission not declared at read site not established

request: BaseAnalyticsResource. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

response: BaseAnalyticsResource. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Declared refusal/error evidence: PermissionDenied: You are not authorized to create analytics configs.

retrieve · GET

GET /api/{installed_plugin_prefix}/config/{external_id}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true
path external_id router lookup string; semantic ID validation requires handler/schema review true

response: BaseAnalyticsResource. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

update · PUT

PUT /api/{installed_plugin_prefix}/config/{external_id}/ — action update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true
path external_id router lookup string; semantic ID validation requires handler/schema review true

request: BaseAnalyticsResource. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

response: BaseAnalyticsResource. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Declared refusal/error evidence: PermissionDenied: You are not authorized to create analytics configs.

partial_update · PATCH

PATCH /api/{installed_plugin_prefix}/config/{external_id}/ — action partial_update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true
path external_id router lookup string; semantic ID validation requires handler/schema review true

request: BaseAnalyticsResource. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

response: BaseAnalyticsResource. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

destroy · DELETE

DELETE /api/{installed_plugin_prefix}/config/{external_id}/ — action destroy. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true
path external_id router lookup string; semantic ID validation requires handler/schema review true

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Explicit response statuses in observed code: status.HTTP_204_NO_CONTENT. Other branches/framework exception handling may differ.

Declared refusal/error evidence: PermissionDenied: You are not authorized to create analytics configs.

generate_analytics_url · POST

POST /api/{installed_plugin_prefix}/config/{external_id}/generate_analytics_url/ — action generate_analytics_url. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true
path external_id router lookup string; semantic ID validation requires handler/schema review true

decorator request: GenerateAnalyticsUrlRequest. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
context_id str true No extra constraint extracted

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Integration review checklist

Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure.

Pinned source evidence

Links require access to the private source repository.