Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /config/event_sources/custom_properties/ calculated_properties/{calculated_property_id}

Retrieves a calculated event property based on the supplied calculated property ID.

Retrieves a calculated event property based on the supplied calculated property ID.

Table 1: GET /config/event_sources/custom_properties/calculated_properties/{calculated_property_id} Resource Details

MIME Type

application/json

Table 2: GET /config/event_sources/custom_properties/calculated_properties/{calculated_property_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

calculated_

property_id

path

Required

Number (Integer)

text/plain

Required - String - The ID of the calculated event property.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: GET /config/event_sources/custom_properties/calculated_properties/{calculated_property_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The requested calculated event property was retrieved.

404

1002

The requested calculated event property cannot be found.

422

1005

One or more parameters are invalid in the request.

500

1020

An error occurred during the attempt to retrieve the requested calculated event property.

Response Description

A calculated event property that contains the following fields:

  • id - Number - A sequence id for the calculated event property.

  • identifier - String - A string that uniquely identifies the calculated event property.

  • name - String - The name of the calculated event property.

  • description - String - The description of the calculated event property.

  • enabled - Boolean - Whether the calculated event property is enabled.

  • first_operand - String - An operand object describing the first operand in the expression.

  • second_operand - String - An operand object describing the second operand in the expression.

  • operator - String - A string that represents one of the basic arithmetic operations in the expression.

  • username - String - The username of the creator of the calculated event property.

  • creation_date - Number - The time stamp for when the calculated event property is created in milliseconds since epoch.

  • modification_date - Number - The time stamp for when the calculated event property is last modified in milliseconds since epoch.

An operand object contains the following fields:

  • type - String - can be "STATIC" (for numeric operand) or "PROPERTY" (for operand that is a property).

  • numeric_value - Number - when property_type is "STATIC", this is the value of the operand; otherwise, it is suppressed.

  • property_name - String - when property_type is "PROPERTY", this is the name of the property that is being used as the operand; otherwise, it is suppressed.

Response Sample