---
title: "LeadOpptyKPIs.get"
method: GET
path: "/entities/LeadOpptyKPIs/{id}"
tags: ["Lead & Opportunity"]
---

# LeadOpptyKPIs.get

`GET /entities/LeadOpptyKPIs/{id}`

Returns LeadOpptyKPI with given id

## Path parameters

- `id` string, uuid, required

## Response `200`

LeadOpptyKPI data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` LeadOpptyKPI
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `client` string, uri — User who triggered the KPI event (e.g. created the lead, qualified it, won or lost the opportunity, moved the record). Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `lead` string, uri — Lead this KPI event relates to. Set when lead_oppty_id resolves to a Lead; otherwise empty. Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties.
    - `oppty` string, uri — Opportunity this KPI event relates to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.
    - `owner` string, uri — Lead/opportunity owner at the time the KPI event occurred. Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `unit` string, uri, required — Sales unit the triggering user belonged to at the time of the event. Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties.
    - `application_id` string, uuid — Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration).
    - `client_id` string, uuid — Id of the user who triggered the event.
    - `kpi` 1 | 2 | 4 | 5 | 6 | 7 | 8, required — KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove. Integer enum value: 1 - CreateLeads, 2 - CreateOppty, 4 - QualifyLead, 5 - WinOppty, 6 - LoseLead, 7 - LoseOppty, 8 - LastMove
    - `lead_oppty_id` string, uuid, required — Id of the lead or opportunity the KPI event relates to.
    - `owner_id` string, uuid — Id of the lead/opportunity owner at the time of the event.
    - `unit_id` string, uuid, required — Id of the sales unit.
    - `revision` integer — Revision when entity was lastly changed.

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)