API degli attributi calcolati - Amazon Connect

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

API degli attributi calcolati

È possibile utilizzare le seguenti API di attributo calcolate di Profili cliente

CreateCalculatedAttributeDefinition

CreateCalculatedAttributeDefinition

Crea un nuovo attributo calcolato. Ciò richiede un tipo di oggetto esistente nel dominio. È possibile definire gli attributi che si desidera estrarre da un singolo oggetto di origine e le operazioni matematiche da applicare ad essi in forma aggregata, nonché l'intervallo di tempo e il conteggio degli oggetti.

Dopo la creazione, i nuovi dati oggetto importati nei profili dei clienti verranno inclusi nell'attributo calcolato, che può essere recuperato per un profilo utilizzando l'API GetCalculatedAttributeForProfile. La definizione di un attributo calcolato lo rende disponibile per tutti i profili all'interno di un dominio. Ogni attributo calcolato può fare riferimento solo a uno ObjectType o al massimo due campi ObjectType.

Richiesta

POST /domains/DomainName/calculated-attributes/CalculatedAttributeName
                            

{
    "CalculatedAttributeName": "string",
    "DisplayName": "string",
    "Description": "string",
    "AttributeDetails": {
       "Attributes": [
           {
               "Name": "string"
           }
           ...
       ],
       "Expression": "string",
    },
    "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE",
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
     },
     "Tags": {}
}

Risposta


{
    "CalculatedAttributeName": "string",
    "DisplayName": "string",
    "Description": "string",
    "AttributeDetails": {
       "Attributes": [
           {
               "Name": "string"
           }
           ...
       ],
       "Expression": "string",
    },
    "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE"
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
    },
    "CreatedAt": number,
    "LastUpdatedAt": number,
    "Tags": {}
}

Corpo della richiesta

  • CalculatedAttributeName

    Il nome univoco (per dominio) dell'attributo calcolato.

    • Tipo: stringa

    • Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

    • Modello: ^[a-zA-Z0-9_-]+$

    • Campo obbligatorio: sì

  • DisplayName

    Il nome visualizzato dell'attributo calcolato.

    • Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

    • Modello: ^[a-zA-Z_][a-zA-Z_0-9-\s]*$

    • Campo obbligatorio: no

  • Descrizione

    La descrizione dell'attributo calcolato.

    • Tipo: stringa

    • Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 1000.

    • Campo obbligatorio: no

  • AttributeDetails

    Dettagli degli attributi utilizzati nella definizione e delle operazioni matematiche coinvolte tra gli attributi. Vedi i seguenti componenti:

    • Attributes

      Un elenco di elementi di attributo specificati nell'espressione matematica.

      • AttributeItem

        I dettagli di un singolo elemento di attributo specificato nell'espressione matematica.

        • Nome

          • Il nome di un attributo definito in un tipo di oggetto profilo.

          • ▬Tipo: stringa

    • Expression

      Espressione matematica che viene eseguita sugli elementi degli attributi forniti nell'elenco degli attributi. Ogni elemento dell'espressione deve seguire la struttura di\ "{ObjectTypeName. AttributeName}\».

      • Esempio: {ObjA.AttributeA} - {ObjA.AttributeB}

      • Tipo: stringa

      • Supportiamo solo le seguenti operazioni matematiche: + - * /

      • È impossibile apportare modifiche all'espressione una volta creata una definizione di attributo calcolata

  • Condizioni

    Definisce i criteri e la soglia di aggregazione degli attributi calcolati.

    • Tipo: oggetto Condizioni

      • Intervallo

      • ObjectCount

      • Threshold

  • Range

    Il periodo di tempo relativo durante il quale i dati vengono inclusi nell'aggregazione.

    • Tipo: oggetto Range

      • Valore: la durata delle unità specificate

      • Unità: unità di tempo

        • Valori validi: giorni

    • Campo obbligatorio: sì

    • Ambito iniziale: massimo 366 giorni

  • ObjectCount

    Il numero di oggetti del profilo utilizzati per l'attributo calcolato.

    • Tipo: numero

    • Intervallo: da 1 a 100

    • Campo obbligatorio: no

  • Threshold

    La logica di confronto per generare un attributo calcolato vero/falso.

    • Tipo: oggetto Threshold

      • Valore

        • Il valore di una soglia

        • ▬Tipo: stringa

        • Campo obbligatorio: no

      • Operatore

        • L'operatore della soglia

        • Tipo: ENUM

        • Valori validi:

          • GREATER_THAN

          • LESS_THAN

          • EQUAL_TO

          • NON_EQUAL_TO

    • Campo obbligatorio: no

  • Statistic

    L'operazione di aggregazione da eseguire per l'attributo calcolato.

    • Tipo: ENUM

    • Valori validi:

      • FIRST_OCCURRENCE

      • LAST_OCCURRENCE

      • COUNT

      • SUM

      • MINIMUM

      • MAXIMUM

      • AVERAGE

      • MAX_OCCURRENCE

UpdateCalculatedAttributeDefinition

UpdateCalculatedAttributeDefinition

Aggiorna una definizione di attributo calcolato. Gli aggiornamenti sono limitati al nome visualizzato, alla descrizione, all'intervallo di tempo, al numero di oggetti e alla soglia. Questa API supporta gli aggiornamenti parziali, quindi è necessario includere solo i parametri che richiedono l'aggiornamento.

Quando aggiorni le Condizioni, tieni presente che l'aumento dell'intervallo di date di un attributo calcolato non attiverà l'inclusione di dati storici superiori all'intervallo di date corrente.

Richiesta

PUT /domains/DomainName/calculated-attributes/CalculatedAttributeName
                            

{
    "DisplayName": "string",
    "Description": "string",
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
   }
}

Risposta


{
    "CalculatedAttributeName": "string",
    "DisplayName": "string",
    "Description": "string",
    "AttributeDetails": {
       "Attributes": [
           {
               "Name": "string"
           }
           ...
       ],
       "Expression": "string",
    },
    "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE"
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
    },
    "CreatedAt": number,
    "LastUpdatedAt": number,
    "Tags": {}
}

Corpo della richiesta

  • DisplayName

    Il nome visualizzato dell'attributo calcolato.

    • Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

    • Modello: ^[a-zA-Z_][a-zA-Z_0-9-\s]*$

    • Campo obbligatorio: no

  • Descrizione

    La descrizione dell'attributo calcolato.

    • Tipo: stringa

    • Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 1000.

    • Campo obbligatorio: no

  • Condizioni

    Definisce i criteri e la soglia di aggregazione degli attributi calcolati.

    • Tipo: oggetto Condizioni

      • Intervallo

      • ObjectCount

      • Threshold

  • Range

    Il periodo di tempo relativo durante il quale i dati vengono inclusi nell'aggregazione.

    • Tipo: oggetto Range

      • Valore: la durata delle unità specificate

      • Unità: unità di tempo

        • Valori validi: giorni

    • Campo obbligatorio: sì

    • Ambito iniziale: massimo 366 giorni

  • ObjectCount

    Il numero di oggetti del profilo utilizzati per l'attributo calcolato.

    • Tipo: numero

    • Intervallo: da 1 a 100

    • Campo obbligatorio: no

  • Threshold

    La logica di confronto per generare un attributo calcolato vero/falso.

    • Tipo: oggetto Threshold

      • Valore

        • Il valore di una soglia

        • ▬Tipo: stringa

        • Campo obbligatorio: no

      • Operatore

        • L'operatore della soglia

        • Tipo: ENUM

        • Valori validi:

          • GREATER_THAN

          • LESS_THAN

          • EQUAL_TO

          • NON_EQUAL_TO

    • Campo obbligatorio: no

GetCalculatedAttributeDefinition

GetCalculatedAttributeDefinition

Recupera una definizione di attributo calcolata.

Richiesta

GET /domains/DomainName/calculated-attributes/CalculatedAttributeName

Corpo della richiesta

The request does not have a request body.

Risposta


{
    "CalculatedAttributeName": "string",
    "DisplayName": "string",
    "Description": "string",
    "AttributeDetails": {
       "Attributes": [
           {
               "Name": "string"
           }
           ...
       ],
       "Expression": "string",
    },
    "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE"
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
    },
    "CreatedAt": number,
    "LastUpdatedAt": number,
    "Tags": {}
}

Parametri della richiesta URI

  • DomainName

    Il nome univoco del dominio.

    • Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

    • Modello: ^[a-zA-Z0-9_-]+$

    • Campo obbligatorio: sì

  • CalculatedAttributeName

    Il nome univoco (per dominio) dell'attributo calcolato.

    • Tipo: stringa

    • Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

    • Modello: ^[a-zA-Z0-9_-]+$

    • Campo obbligatorio: sì

DeleteCalculatedAttributeDefinition

DeleteCalculatedAttributeDefinition

Elimina una definizione di attributo calcolato esistente. Tieni presente che è possibile eliminare un attributo calcolato predefinito, tuttavia una volta eliminato non sarai in grado di annullare tale azione e dovrai ricrearlo da solo utilizzando l'API CreateCalculatedAttributeDefinition se desideri ripristinarlo.

Richiesta

DELETE /domains/DomainName/calculated-attributes/CalculatedAttributeName

Corpo della richiesta

The request does not have a request body.

Risposta

The response does not have a response body.

Parametri della richiesta URI

  • DomainName

    Il nome univoco del dominio.

    • Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

    • Modello: ^[a-zA-Z0-9_-]+$

    • Campo obbligatorio: sì

  • CalculatedAttributeName

    Il nome univoco (per dominio) dell'attributo calcolato.

    • Tipo: stringa

    • Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

    • Modello: ^[a-zA-Z0-9_-]+$

    • Campo obbligatorio: sì

ListCalculatedAttributeDefinitions

ListCalculatedAttributeDefinitions

Recupera tutte le definizioni degli attributi calcolati per un dominio.

Richiesta

GET /domains/DomainName/calculated-attributes?max-results=MaxResults&next-token=NextToken

Corpo della richiesta

The request does not have a request body.

Risposta


{
    "Items": [
        {
            "CalculatedAttributeName": "string",
            "DisplayName": "string",
            "Description": "string",
            "CreatedAt": "timestamp",
            "LastUpdatedAt": "timestamp"
        },
        ...
    ],
    "NextToken": "string"
}

Parametri della richiesta URI

  • DomainName

    Il nome univoco del dominio.

    • Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

    • Modello: ^[a-zA-Z0-9_-]+$

    • Campo obbligatorio: sì

  • MaxResults

    Il numero massimo di oggetti restituiti per pagina.

    • Intervallo valido: valore minimo di 1. Valore massimo pari a 100

  • NextToken

    Il token di impaginazione della precedente chiamata ListCalculatedAttributeDefinition API.

    • Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 1024 caratteri

GetCalculatedAttributeForProfile

GetCalculatedAttributeForProfile

Avvia il calcolo e recupera il risultato di un singolo attributo calcolato per un singolo profilo.

Richiesta

GET /domains/DomainName/profile/ProfileId/calculated-attributes/CalculatedAttributeName

Corpo della richiesta

The request does not have a request body.

Risposta


{
    "Name": "string",
    "DisplayName": "string",
    "Value": "string",
    "IsDataPatrial": "string"
}

Parametri della richiesta URI

  • DomainName

    Il nome univoco del dominio.

    • Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

    • Modello: ^[a-zA-Z0-9_-]+$

    • Campo obbligatorio: sì

  • CalculatedAttributeName

    Il nome univoco (per dominio) dell'attributo calcolato.

    • Tipo: stringa

    • Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

    • Modello: ^[a-zA-Z0-9_-]+$

    • Campo obbligatorio: sì

ListCalculatedAttributesForProfile

ListCalculatedAttributesForProfile

Avvia il calcolo e recupera i risultati di tutti gli attributi calcolati per un singolo profilo.

Richiesta

GET /domains/DomainName/profile/ProfileId/calculated-attributes?max-results=MaxResults&next-token=NextToken

Corpo della richiesta

The request does not have a request body.

Risposta


{
    "Items": [
        {
            "CalculatedAttributeName": "string",
            "DisplayName": "string",
            "Value": "string",
            "IsDataPartial" : "string"
        },
        ...
    ],
    "NextToken": "string"
}

Parametri della richiesta URI

  • DomainName

    Il nome univoco del dominio.

    • Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

    • Modello: ^[a-zA-Z0-9_-]+$

    • Campo obbligatorio: sì

  • ProfileId

    • Modello: [a-f0-9]{32}

    • Campo obbligatorio: sì

  • MaxResults

    Il numero massimo di oggetti restituiti per pagina.

    • Intervallo valido: valore minimo di 1. Valore massimo pari a 100

  • NextToken

    Il token di impaginazione della precedente chiamata ListCalculatedAttributeDefinition API.

    • Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 1024 caratteri