API d'attributs calculés - Amazon Connect

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

API d'attributs calculés

Vous pouvez utiliser les API d'attributs calculés Profils des clients suivantes :

CreateCalculatedAttributeDefinition

CreateCalculatedAttributeDefinition

Créez un nouvel attribut calculé. Cela nécessite un type d'objet existant dans le domaine. Vous pouvez définir les attributs que vous souhaitez extraire d'un seul objet source et les opérations mathématiques à leur appliquer de manière agrégée, ainsi que la plage de temps et le nombre d'objets.

Après la création, les nouvelles données d'objet ingérées dans Profils des clients seront incluses dans l'attribut calculé, qui peut être récupéré pour un profil à l'aide de l'API GetCalculatedAttributeForProfile. La définition d'un attribut calculé le rend disponible pour tous les profils d'un domaine. Chaque attribut calculé ne peut référencer qu'un seul champ ObjectType et au plus deux à partir de celui-ci ObjectType.

Demande

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": {}
}

Réponse


{
    "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": {}
}

Corps de la demande

  • CalculatedAttributeNom

    Le nom unique (par domaine) de l'attribut calculé.

    • Type : chaîne

    • Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

    • Modèle : ^[a-zA-Z0-9_-]+$

    • Obligatoire : oui

  • DisplayName

    Le nom d'affichage de l'attribut calculé.

    • Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

    • Modèle : ^[a-zA-Z_][a-zA-Z_0-9-\s]*$

    • Obligatoire : non

  • Description

    La description de l'attribut calculé.

    • Type : chaîne

    • Contraintes de longueur : longueur minimum de 1. Longueur maximum de 1 000.

    • Obligatoire : non

  • AttributeDetails

    Les détails des attributs utilisés dans la définition et des opérations mathématiques impliquées entre les attributs. Consultez les composants suivants :

    • Attributs

      Une liste des éléments d'attribut spécifiés dans l'expression mathématique.

      • AttributeItem

        Les détails d'un élément d'attribut unique spécifié dans l'expression mathématique.

        • Nom

          • Le nom d'un attribut défini dans un type d'objet de profil.

          • Type : chaîne

    • Expression

      L'expression mathématique exécutée sur les éléments d'attribut fournis dans la liste d'attributs. Chaque élément de l'expression doit suivre la structure de \ "{ObjectTypeNom. AttributeName} \ ».

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

      • Type : chaîne

      • Nous prenons uniquement en charge les opérations mathématiques suivantes : + - * /

      • Vous ne pouvez pas modifier l'expression une fois qu'une définition d'attribut calculée est créée

  • Conditions

    Définit les critères et seuils d'agrégation d'attributs calculés.

    • Type : objet de conditions

      • Range

      • ObjectCount

      • Seuil

  • Range

    La période relative pendant laquelle les données sont incluses dans l'agrégation.

    • Type : objet Range

      • Valeur : durée des unités spécifiées

      • Unité : unité de temps

        • Valeurs valides : jours

    • Obligatoire : oui

    • Portée initiale : 366 jours maximum

  • ObjectCount

    Le nombre d'objets de profil utilisés pour l'attribut calculé.

    • Type : nombre

    • Plage : 1 à 100

    • Obligatoire : non

  • Threshold

    La logique de comparaison pour générer un attribut calculé true/false.

    • Type : objet Threshold

      • Valeur

        • La valeur du seuil

        • Type : chaîne

        • Obligatoire : non

      • Opérateur

        • L'opérateur du seuil

        • Type : ENUM

        • Valeurs valides :

          • GREATER_THAN

          • LESS_THAN

          • EQUAL_TO

          • NOT_EQUAL_TO

    • Obligatoire : non

  • Statistique

    L'opération d'agrégation à effectuer pour l'attribut calculé.

    • Type : ENUM

    • Valeurs valides :

      • FIRST_OCCURRENCE

      • LAST_OCCURRENCE

      • COUNT

      • SUM

      • MINIMUM

      • MAXIMUM

      • AVERAGE

      • MAX_OCCURRENCE

UpdateCalculatedAttributeDefinition

UpdateCalculatedAttributeDefinition

Mettez à jour une définition d'attribut calculée. Les mises à jour sont limitées au nom d'affichage, à la description, à la plage de temps, au nombre d'objets et au seuil. Cette API prend en charge les mises à jour partielles, de sorte que seuls les paramètres nécessitant une mise à jour doivent être inclus.

Lorsque vous mettez à jour les conditions, notez que l'augmentation de la plage de dates d'un attribut calculé ne déclenchera pas l'inclusion de données historiques supérieures à la plage de dates actuelle.

Demande

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"
        }
   }
}

Réponse


{
    "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": {}
}

Corps de la demande

  • DisplayName

    Le nom d'affichage de l'attribut calculé.

    • Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

    • Modèle : ^[a-zA-Z_][a-zA-Z_0-9-\s]*$

    • Obligatoire : non

  • Description

    La description de l'attribut calculé.

    • Type : chaîne

    • Contraintes de longueur : longueur minimum de 1. Longueur maximum de 1 000.

    • Obligatoire : non

  • Conditions

    Définit les critères et seuils d'agrégation d'attributs calculés.

    • Type : objet de conditions

      • Range

      • ObjectCount

      • Seuil

  • Range

    La période relative pendant laquelle les données sont incluses dans l'agrégation.

    • Type : objet Range

      • Valeur : durée des unités spécifiées

      • Unité : unité de temps

        • Valeurs valides : jours

    • Obligatoire : oui

    • Portée initiale : 366 jours maximum

  • ObjectCount

    Le nombre d'objets de profil utilisés pour l'attribut calculé.

    • Type : nombre

    • Plage : 1 à 100

    • Obligatoire : non

  • Threshold

    La logique de comparaison pour générer un attribut calculé true/false.

    • Type : objet Threshold

      • Valeur

        • La valeur du seuil

        • Type : chaîne

        • Obligatoire : non

      • Opérateur

        • L'opérateur du seuil

        • Type : ENUM

        • Valeurs valides :

          • GREATER_THAN

          • LESS_THAN

          • EQUAL_TO

          • NOT_EQUAL_TO

    • Obligatoire : non

GetCalculatedAttributeDefinition

GetCalculatedAttributeDefinition

Récupérez une définition d'attribut calculée.

Demande

GET /domains/DomainName/calculated-attributes/CalculatedAttributeName

Corps de la demande

The request does not have a request body.

Réponse


{
    "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": {}
}

Paramètres de demande URI

  • DomainName

    Nom unique du domaine.

    • Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

    • Modèle : ^[a-zA-Z0-9_-]+$

    • Obligatoire : oui

  • CalculatedAttributeNom

    Le nom unique (par domaine) de l'attribut calculé.

    • Type : chaîne

    • Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

    • Modèle : ^[a-zA-Z0-9_-]+$

    • Obligatoire : oui

DeleteCalculatedAttributeDefinition

DeleteCalculatedAttributeDefinition

Supprimez une définition d'attribut calculé existante. Notez que la suppression d'un attribut calculé par défaut est possible, mais une fois supprimé, vous ne pourrez plus annuler cette action et vous devrez le recréer vous-même à l'aide de l'API CreateCalculatedAttributeDefinition si vous souhaitez le récupérer.

Demande

DELETE /domains/DomainName/calculated-attributes/CalculatedAttributeName

Corps de la demande

The request does not have a request body.

Réponse

The response does not have a response body.

Paramètres de demande URI

  • DomainName

    Nom unique du domaine.

    • Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

    • Modèle : ^[a-zA-Z0-9_-]+$

    • Obligatoire : oui

  • CalculatedAttributeNom

    Le nom unique (par domaine) de l'attribut calculé.

    • Type : chaîne

    • Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

    • Modèle : ^[a-zA-Z0-9_-]+$

    • Obligatoire : oui

ListCalculatedAttributeDefinitions

ListCalculatedAttributeDefinitions

Récupérez toutes les définitions d'attributs calculées pour un domaine.

Demande

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

Corps de la demande

The request does not have a request body.

Réponse


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

Paramètres de demande URI

  • DomainName

    Nom unique du domaine.

    • Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

    • Modèle : ^[a-zA-Z0-9_-]+$

    • Obligatoire : oui

  • MaxResults

    Le nombre maximum d'objets renvoyés par page.

    • Plage valide : valeur minimum de 1. Valeur maximale de 100

  • NextToken

    Le jeton de pagination issu de l'appel ListCalculatedAttributeDefinition d'API précédent.

    • Contraintes de longueur : longueur minimum de 1. Longueur maximum de 1 024

GetCalculatedAttributeForProfile

GetCalculatedAttributeForProfil

Lance le calcul et récupère le résultat d'un seul attribut calculé pour un seul profil.

Demande

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

Corps de la demande

The request does not have a request body.

Réponse


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

Paramètres de demande URI

  • DomainName

    Nom unique du domaine.

    • Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

    • Modèle : ^[a-zA-Z0-9_-]+$

    • Obligatoire : oui

  • CalculatedAttributeNom

    Le nom unique (par domaine) de l'attribut calculé.

    • Type : chaîne

    • Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

    • Modèle : ^[a-zA-Z0-9_-]+$

    • Obligatoire : oui

ListCalculatedAttributesForProfile

ListCalculatedAttributesForProfil

Lance le calcul et récupère les résultats de tous les attributs calculés pour un seul profil.

Demande

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

Corps de la demande

The request does not have a request body.

Réponse


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

Paramètres de demande URI

  • DomainName

    Nom unique du domaine.

    • Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

    • Modèle : ^[a-zA-Z0-9_-]+$

    • Obligatoire : oui

  • ProfileId

    • Modèle : [a-f0-9]{32}

    • Obligatoire : oui

  • MaxResults

    Le nombre maximum d'objets renvoyés par page.

    • Plage valide : valeur minimum de 1. Valeur maximale de 100

  • NextToken

    Le jeton de pagination issu de l'appel ListCalculatedAttributeDefinition d'API précédent.

    • Contraintes de longueur : longueur minimum de 1. Longueur maximum de 1 024