Skip to content
Cloud APIs
/
FDPlan
/
/Kpis

Kpis

Manage Key Performance Indicators (KPIs).

Operations

Get the list of Key Performance Indicators (KPIs).

Request

Returns the tenant-wide catalog of Key Performance Indicators (KPIs) - the reusable metrics such as NPV, IRR, payback period, or first-oil date that studies target through their KPOs. The catalog includes both built-in system KPIs and any custom KPIs registered for the partition, and is paginated with the pageNumber and pageSize parameters.

Security
bearer and appkey
Query
pageNumberinteger

The number of the page in the list of KPIs

Default:0
pageSizeinteger

The number of KPIs per page

Default:100
Headers
slb-partition-idstringrequired

Data partition id.

curl -i -X GET \
  'https://api.delfi.slb.com/fdplan/studies/v1/kpis?pageNumber=0&pageSize=100' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string'

Responses

Success.

Bodyapplication/json
itemsArray of objects(Kpi)required
Example:
[
  {
    "name": "First Year Capex",
    "isSystem": false,
    "lastUpdated": { … },
    "description": "Capital Expenditures at first year",
    "type": "Money",
    "defaultObjectiveOperator": "Less Than",
    "unit": "M$",
    "priority": 11,
    "archived": false
  },
  {
    "name": "First Oil",
    "isSystem": false,
    "lastUpdated": { … },
    "description": "Date of First Oil",
    "type": "Date",
    "defaultObjectiveOperator": "Before",
    "priority": 14,
    "archived": false
  }
]
Response
{
  "items": [
    { … },
    { … }
  ]
}