DocsICP FilingConsole
Documentation

CreateABMetric

Updated at:
Copy as MD
Product
My Favorites

Creates an AB test metric.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

pairec:CreateABMetric

create

*All Resource

*

 None None

Request syntax

POST /api/v1/abmetrics HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
body

object

No

The request body parameters.

Name

string

Yes

The name of the metric.

pv
Description

string

Yes

The description of the metric.

PV metric
SceneId

string

Yes

The ID of the scene. You can call the ListScenes operation to obtain the ID.

1
Type

string

Yes

The type of the metric. Valid values:

  • Single: single metric.

  • Derived: derived metric.

Single
Realtime

boolean

Yes

Specifies whether the metric is a real-time metric. Valid values:

  • true: yes.

  • false: no.

false
TableMetaId

string

Yes

The ID of the data table. You can call the ListTableMetas operation to obtain the ID.

2
ResultResourceId

string

No

The ID of the data source to which the data table is written back. You can call the ListInstanceResources operation to obtain the ID.

3
Definition

string

Yes

The definition of the metric.

sum(click_cnt)
StatisticsCycle

integer

No

The statistical period.

1
LeftMetricId

string

No

The ID of the left metric for a derived metric.

2
RightMetricId

string

No

The ID of the right metric for a derived metric.

3
Operator

string

No

The operator used to calculate a derived metric. Valid values:

  • Plus: addition.

  • Minus: subtraction.

  • Multiplication: multiplication.

  • Division: division.

Division
InstanceId

string

Yes

Instance ID of the instance. You can call the ListInstances operation to obtain instance ID.

pairec-cn-test1
NeedSignificance

boolean

No

Specifies whether to calculate significance.

AggregationByUser

boolean

No

Specifies whether to aggregate by user dimension when calculating significance. Two aggregation methods are available: by user and by sample.

Numerator

string

No

The numerator used for significance calculation.

click
Denominator

string

No

The denominator used for significance calculation.

pv
IsBinomialDistribution

boolean

No

Specifies whether the current metric follows a binomial distribution when the metric type is a derived metric. If yes, the mean and variance of the metric are calculated based on the binomial distribution.

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The ID of the request.

F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA
ABMetricId

string

The ID of the AB test metric.

1

Examples

Success response

JSON format

{
  "RequestId": "F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA",
  "ABMetricId": "1"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.