User GuideAPI ReferenceDSLWhat's NewChangelog
API Reference

Update KPI mapping group

patch
https://analytics.api.exabel.com/v1/kpiMappings//groups/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The ID of a KPI mapping, e.g. 123.

integer
required

The ID of a KPI mapping group, e.g. 123.

Query Params
string

Use this to update only selected fields. For example, specify displayName to update only the display name.

For REST requests, this is a comma-separated string.

Body Params

KpiMappingGroup to update.

string

Display name.

kpi
object

The KPI for the group.

proxySignal
object

Proxy signal.

string
enum
Defaults to KPI_MAPPING_GROUP_TYPE_UNSPECIFIED

Type of KPI mapping group.

  • KPI_MAPPING_GROUP_TYPE_UNSPECIFIED: Unspecified.
  • BULK: Bulk mapping groups.
  • COMPANY_SPECIFIC: Company specific mapping groups.
Allowed:
entitySet
object

The entities for which this group defines KPI mappings. All the entities must be companies.

string
enum
Defaults to RESAMPLE_METHOD_UNSPECIFIED

Specifies how to resample the proxy signal.

  • RESAMPLE_METHOD_UNSPECIFIED: Unspecified.
  • NO_RESAMPLE: No resampling.
  • RESAMPLE_MEAN: Mean.
  • RESAMPLE_SUM: Sum.
  • RESAMPLE_MEDIAN: Median.
  • RESAMPLE_MEAN_TIMES_DAYS: Mean times days.
  • RESAMPLE_LAST: Last.
Allowed:
forecastingOptions
object

Specifies how proxy signal forecasting should be performed.

modelOptions
object

Configuration for the single-predictor models that are built for this group.

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?