--- title: "Read software performance" description: "Installation-scoped custom software. Requires a server credential. Collection, application and TEST/LIVE environment come from the credential. Settings are revisioned; engagement is client-reported, not consent or booking authority. Canonical outcome attribution is currently unavailable. Browser components use their same-origin server boundary; never expose the server credential." --- `GET /v1/developer/collections/{collection}/software/{module}/performance` **Operation ID:** `getDeveloperSoftwarePerformance` Installation-scoped custom software. Requires a server credential. Collection, application and TEST/LIVE environment come from the credential. Settings are revisioned; engagement is client-reported, not consent or booking authority. Canonical outcome attribution is currently unavailable. Browser components use their same-origin server boundary; never expose the server credential. ## Contract status | Field | Value | | --- | --- | | Maturity | `beta` | | Required capability | `telemetry.read` | | Freshness class | `authenticated-state` | | Quota cost | `1` | All operations require a Kismet Developer Bearer credential. Collection and resource authority is resolved from the credential's installation grants; identifiers in the URL never grant access. ## Request parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `from` | query | string | yes | | | `to` | query | string | yes | | | `revision` | query | integer | yes | | | `collection` | path | string | yes | | | `module` | path | string | yes | | ## Request body This operation has no JSON request body. ## cURL Set `KISMET_API_ORIGIN=https://api.ksmt.app` and configure `KISMET_DEVELOPER_API_KEY` in your environment. Run server-credential requests from your backend, not browser code. ```sh curl --request GET \ "$KISMET_API_ORIGIN/v1/developer/collections/example-collection/software/{module}/performance?from=string&to=string&revision=1" \ --header "Authorization: Bearer $KISMET_DEVELOPER_API_KEY" \ --header "Accept: application/json" ``` ## Responses | Status | Meaning | | --- | --- | | 200 | Success. | | 400 | Invalid request parameters or body. | | 401 | Missing, invalid, expired, or inappropriate credential/session. | | 403 | Credential lacks the required grant/capability, or an origin/CSRF check failed. | | 404 | The authorized resource was not found. | | 409 | Request conflicts with the installation environment or current state. | | 429 | Rate limit or quota exceeded; inspect response metadata before retrying. | | 503 | A required Kismet dependency is temporarily unavailable. | ### 200 response example ```json { "moduleId": "welcome-offer", "installationId": "33333333-3333-4333-8333-333333333333", "collectionId": "44444444-4444-4444-8444-444444444444", "environment": "TEST", "assignmentUnit": "session", "revision": 1, "period": { "from": "2026-09-01T00:00:00.000Z", "to": "2026-09-02T00:00:00.000Z", "basis": "enrolled_at" }, "generatedAt": "2026-09-02T00:00:00.000Z", "lastEventAt": "2026-09-01T12:00:00.000Z", "coverage": { "status": "complete", "basis": "received_events", "reasons": [], "earliestAvailableAt": "2026-09-01T00:00:00.000Z" }, "variants": [ { "id": "first-page", "label": "First page", "assignedVisits": 205, "displayedVisits": 40, "actions": [ { "id": "claim", "label": "Claim selected", "visits": 3, "events": 4 } ], "verifiedOutcomes": { "marketingSignup": { "status": "unavailable", "convertedVisits": null, "rate": null, "reason": "Canonical outcome attribution is not available for software modules." }, "confirmedBooking": { "status": "unavailable", "convertedVisits": null, "rate": null, "reason": "Canonical outcome attribution is not available for software modules." } } }, { "id": "second-page", "label": "Second page", "assignedVisits": 205, "displayedVisits": 20, "actions": [ { "id": "claim", "label": "Claim selected", "visits": 3, "events": 4 } ], "verifiedOutcomes": { "marketingSignup": { "status": "unavailable", "convertedVisits": null, "rate": null, "reason": "Canonical outcome attribution is not available for software modules." }, "confirmedBooking": { "status": "unavailable", "convertedVisits": null, "rate": null, "reason": "Canonical outcome attribution is not available for software modules." } } } ] } ``` ### 200 response schema Content type: `application/json`. Required fields, nullable values, and nested structures are defined below.
View complete response schema ```json { "type": "object", "properties": { "moduleId": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "installationId": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "assignmentUnit": { "type": "string", "enum": [ "session" ] }, "revision": { "type": "integer", "minimum": 1 }, "period": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "basis": { "type": "string", "enum": [ "enrolled_at" ] } }, "required": [ "from", "to", "basis" ], "additionalProperties": false }, "generatedAt": { "type": "string", "format": "date-time" }, "lastEventAt": { "type": "string", "format": "date-time", "nullable": true }, "coverage": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "complete", "partial", "unavailable" ] }, "basis": { "type": "string", "enum": [ "received_events" ] }, "reasons": { "type": "array", "items": { "type": "string" } }, "earliestAvailableAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "status", "basis", "reasons", "earliestAvailableAt" ], "additionalProperties": false }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "label": { "type": "string" }, "assignedVisits": { "type": "integer", "minimum": 0 }, "displayedVisits": { "type": "integer", "minimum": 0 }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "label": { "type": "string" }, "visits": { "type": "integer", "minimum": 0 }, "events": { "type": "integer", "minimum": 0 } }, "required": [ "id", "label", "visits", "events" ], "additionalProperties": false } }, "verifiedOutcomes": { "type": "object", "properties": { "marketingSignup": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "available", "partial", "unavailable" ] }, "convertedVisits": { "type": "integer", "minimum": 0, "nullable": true }, "rate": { "type": "number", "minimum": 0, "maximum": 1, "nullable": true }, "reason": { "type": "string", "nullable": true } }, "required": [ "status", "convertedVisits", "rate", "reason" ], "additionalProperties": false }, "confirmedBooking": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "available", "partial", "unavailable" ] }, "convertedVisits": { "type": "integer", "minimum": 0, "nullable": true }, "rate": { "type": "number", "minimum": 0, "maximum": 1, "nullable": true }, "reason": { "type": "string", "nullable": true } }, "required": [ "status", "convertedVisits", "rate", "reason" ], "additionalProperties": false } }, "required": [ "marketingSignup", "confirmedBooking" ], "additionalProperties": false } }, "required": [ "id", "label", "assignedVisits", "displayedVisits", "actions", "verifiedOutcomes" ], "additionalProperties": false } } }, "required": [ "moduleId", "installationId", "collectionId", "environment", "assignmentUnit", "revision", "period", "generatedAt", "lastEventAt", "coverage", "variants" ], "additionalProperties": false } ```
## Machine-readable sources - [This page as Markdown](/api/reference/get-developer-software-performance.md) - [Developer API OpenAPI v0.7.25](/openapi.json)