Actions

Description

defaultDescription

DEFAULT

DELETE ``/api/v2/analytics/configuration/actiondef/{action-name}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

action-name

path

Yes

string

Generated path parameter. Example value =’action1’

Request

Headers

x-account: Generated header parameter. Example value ='a23da25e-c0cc-11ea-9866-26b621aa8d0e'
authorization: Generated header parameter. Example value ='Session 2fc0b924-e14a-4850-9d7c-50f6c793d9f3'

Responses

202

GET ``/api/v2/analytics/configuration/actiondef``

Request

Headers

x-account: Generated header parameter. Example value ='a23da25e-c0cc-11ea-9866-26b621aa8d0e'
authorization: Generated header parameter. Example value ='Session 2fc0b924-e14a-4850-9d7c-50f6c793d9f3'

Responses

200

Type: array of ActionDetails

Example:

[
    {
        "account_id": "somestring",
        "created_on": "somestring",
        "def_id": "somestring",
        "def_name": "somestring",
        "definition": {
            "email": [
                {
                    "email_ids": [
                        "somestring",
                        "somestring"
                    ],
                    "extended_message": "somestring",
                    "extended_subject": "somestring"
                },
                {
                    "email_ids": [
                        "somestring",
                        "somestring"
                    ],
                    "extended_message": "somestring",
                    "extended_subject": "somestring"
                }
            ],
            "webhook": [
                {
                    "extended_body": "somestring",
                    "headers": {},
                    "uri": "somestring"
                },
                {
                    "extended_body": "somestring",
                    "headers": {},
                    "uri": "somestring"
                }
            ]
        },
        "name": "somestring"
    },
    {
        "account_id": "somestring",
        "created_on": "somestring",
        "def_id": "somestring",
        "def_name": "somestring",
        "definition": {
            "email": [
                {
                    "email_ids": [
                        "somestring",
                        "somestring"
                    ],
                    "extended_message": "somestring",
                    "extended_subject": "somestring"
                },
                {
                    "email_ids": [
                        "somestring",
                        "somestring"
                    ],
                    "extended_message": "somestring",
                    "extended_subject": "somestring"
                }
            ],
            "webhook": [
                {
                    "extended_body": "somestring",
                    "headers": {},
                    "uri": "somestring"
                },
                {
                    "extended_body": "somestring",
                    "headers": {},
                    "uri": "somestring"
                }
            ]
        },
        "name": "somestring"
    }
]

GET ``/api/v2/analytics/configuration/ruleassociation/can_purge/{rule-name}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

rule-name

path

Yes

string

Example values form path are: ‘Trigger2_RD_a23da25e_c0cc_11ea_9866_26b621aa8d0e’ or ‘Action1_AD_a23da25e_c0cc_11ea_9866_26b621aa8d0e’

Request

Headers

x-account: Generated header parameter. Example value ='a23da25e-c0cc-11ea-9866-26b621aa8d0e'
authorization: Generated header parameter. Example value ='Session 716acf99-0440-4181-b6a3-b302e5677e78'

Responses

202

Type: CanPurgeResponse

Example:

{
    "dependency_exists": true
}

POST ``/api/v2/analytics/configuration/actiondef``

Request

Headers

x-account: Generated header parameter. Example value ='a23da25e-c0cc-11ea-9866-26b621aa8d0e'
authorization: Generated header parameter. Example value ='Session 2fc0b924-e14a-4850-9d7c-50f6c793d9f3'

Body

Name

Required

Type

Format

Properties

Description

account_id

No

string

def_name

No

string

definition

No

Definition

filter

No

Filter

type

No

string

{
    "account_id": "somestring",
    "def_name": "somestring",
    "definition": {
        "email": [
            {
                "email_ids": [
                    "somestring",
                    "somestring"
                ],
                "extended_message": "somestring",
                "extended_subject": "somestring"
            },
            {
                "email_ids": [
                    "somestring",
                    "somestring"
                ],
                "extended_message": "somestring",
                "extended_subject": "somestring"
            }
        ],
        "webhook": [
            {
                "extended_body": "somestring",
                "headers": {},
                "uri": "somestring"
            },
            {
                "extended_body": "somestring",
                "headers": {},
                "uri": "somestring"
            }
        ]
    },
    "filter": {
        "account_id": "somestring"
    },
    "type": "somestring"
}

Responses

200

Type: CreateActionResponse

Example:

{
    "account_id": "somestring",
    "created_on": "somestring",
    "def_id": "somestring",
    "def_name": "somestring",
    "definition": {
        "email": [
            {
                "email_ids": [
                    "somestring",
                    "somestring"
                ],
                "extended_message": "somestring",
                "extended_subject": "somestring"
            },
            {
                "email_ids": [
                    "somestring",
                    "somestring"
                ],
                "extended_message": "somestring",
                "extended_subject": "somestring"
            }
        ],
        "webhook": [
            {
                "extended_body": "somestring",
                "headers": {},
                "uri": "somestring"
            },
            {
                "extended_body": "somestring",
                "headers": {},
                "uri": "somestring"
            }
        ]
    },
    "name": "somestring",
    "type": "somestring"
}

Data Structures

Action Definition Request Model Structure

Name

Required

Type

Format

Properties

Description

email

No

array of EmailDefinitionRequest

webhook

No

array of WebhookDefinitionRequest

Action Definition Response Model Structure

Name

Required

Type

Format

Properties

Description

email

No

array of EmailDefinitionResponse

webhook

No

array of WebhookDefinitionResponse

Action Details Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

created_on

No

string

def_id

No

string

def_name

No

string

definition

No

ActionDefinitionResponse

name

No

string

Can Purge Response Model Structure

Name

Required

Type

Format

Properties

Description

dependency_exists

No

boolean

Create Action Request Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

def_name

No

string

definition

No

Definition

filter

No

Filter

type

No

string

Create Action Response Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

created_on

No

string

def_id

No

string

def_name

No

string

definition

No

ActionDefinitionRequest

name

No

string

type

No

string

Definition Model Structure

Name

Required

Type

Format

Properties

Description

email

No

array of Email

webhook

No

array of Webhook

Email Model Structure

Name

Required

Type

Format

Properties

Description

email_ids

No

array of string

extended_message

No

string

extended_subject

No

string

Email Definition Request Model Structure

Name

Required

Type

Format

Properties

Description

email_ids

No

array of string

extended_message

No

string

extended_subject

No

string

Email Definition Response Model Structure

Name

Required

Type

Format

Properties

Description

email_ids

No

array of string

extended_message

No

string

extended_subject

No

string

Filter Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

Headers Model Structure

Webhook Model Structure

Name

Required

Type

Format

Properties

Description

extended_body

No

string

headers

No

Headers

uri

No

string

Webhook Definition Request Model Structure

Name

Required

Type

Format

Properties

Description

extended_body

No

string

headers

No

WebhookHeadersRequest

uri

No

string

Webhook Definition Response Model Structure

Name

Required

Type

Format

Properties

Description

extended_body

No

string

headers

No

WebhookHeadersResponse

uri

No

string

Webhook Headers Request Model Structure

Webhook Headers Response Model Structure