Referencia de la API

Hellotext ofrece una poderosa API REST diseñada para la felicidad del desarrollador. Nos esforzamos constantemente en mantener todos los recursos y acciones simples y consistentes.

Todas las respuestas tienen formato y se devuelven en JSON.

https://api.hellotext.com

Autenticación

Todas las solicitudes a la API deben ser autenticadas. La autenticación se realiza enviando un token con cada solicitud a la API.

Puede crear y administrar tus tokens de autorización desde la sección de Ajustes. Todos los tokens de autorización son específicos del negocio desde el cual se crearon.

Para autenticar, asegúrate de incluir un encabezado de autorización con el formato Authorization: Bearer {token}. Reemplaza el token con el token de autorización.

curl https://api.hellotext.com/v1/profiles \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Errores

Hellotext utiliza códigos de respuesta HTTP convencionales para indicar el estado de una solicitud. Cuando una solicitud es válida pero no se completa como se esperaba, respondemos con un un error 422 y un objeto JSON de errores objeto, incluida una colección de errores que incluye el tipo y la descripción.

Atributos
string
Código en formato string que representa el error.
string
Descripción detallada del error.
string
Nombre del parámetro asociado al error.
400 Bad Request
A menudo falta un parámetro requerido.
401 Unauthorized
No hay clave de API válida.
404 Not Found
El recurso o objeto solicitado no existe.
422 Request Failed
Los parámetros eran válidos pero la solicitud falló.
500, 502, 503, 504 Server errors
Algo salió mal.
ambiguous_parameter
Se proporcionaron uno o más parámetros posibles para el mismo rol. Especifique al menos uno de los valores posibles.
invalid
El valor que proporcionaste para el parámetro no es correcto. Por favor, verifica la documentación para obtener el valor correcto.
not_allowed
La operación no está permitida. Generalmente porque el objeto se encuentra en un estado que no permite la acción.
not_found
Este objeto no fue encontrado. Tal vez fue borrado.
object_invalid
Se debe proporcionar al menos uno de los parámetros opcionales.
parameter_invalid_empty
Uno o más parámetros obligatorios están vacíos.
parameter_missing
Este parámetro es requerido.
parameter_not_unique
El valor debe ser único y ya está presente en otro objeto del mismo tipo.
session_assigned_to_another_profile
Esta sesión ha sido asignada a otro perfil. No se puede usar para rastrear eventos para el perfil actual.
undefined_property
Intentó establecer una propiedad en un perfil que no existía.
{
  "errors": [
    {
      "type": "parameter_missing",
      "message": "This parameter is required.",
      "parameter": "name"
    }
  ]
}

Paginación

Todas las colecciones de recursos de primer nivel se pueden paginar. Las colecciones se ordenan por fecha de creación, mostrando primero los objetos más recientes y limitando los resultados a 25 de forma predeterminada. Para ajustar la cantidad de resultados, puedes utilizar el parámetro limit.

Dado que nuevos objetos serán creados, para mantener el orden consistente en la paginación, puedes obtener el siguiente conjunto de resultados a partir del último ID de la colección anterior utilizando el parámetro starting_after. Esto incluye el siguiente conjunto de resultados después de (excluyendo) el id proporcionado. Esto también se llama paginación vectorial.

También puedes lograr lo contrario y recuperar todos los resultados hasta el identificado dado utilizando el parámetro ending_before.

Parámetros
string
Muestra los resultados después (más antiguos) que el identificador proporcionado.
string
Muestra los resultados antes (más recientes) que el identificador proporcionado.
integer
Limite la cantidad de resultados que se mostrarán. El valor predeterminado es 25. El máximo es 100.
curl -G https://api.hellotext.com/v1/profiles \
  -d starting_after="BvYeyVYz" \
  -d limit=10 \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Perfiles

Los clientes se representan como perfiles. Cada objeto de perfil representa las características de cada cliente y su historial de interacciones con el negocio.

Cada perfil acepta cualquier número de propiedades como números de teléfono, correos electrónicos, direcciones geo-localizadas, atributos personales como cumpleaños, sexo o cualquier otro caso personalizado.

  • POST

    v1/profiles

  • GET

    v1/profiles/:id

  • PATCH

    v1/profiles/:id

  • DELETE

    v1/profiles/:id

  • GET

    v1/profiles

  • POST

    v1/profiles/:id/subscribe

  • POST

    v1/profiles/:id/unsubscribe

  • POST

    v1/profiles/:id/verify

  • DELETE

    v1/profiles/:id/verify

El objeto de perfil

Atributos
id
String
Identificador único del objeto.
Type
Tipo de objeto. Esto es siempre profile.
Boolean
¿Este perfil ha sido bloqueado o no?. Este es true o false.
Epoch
Fecha de creación del objeto.
array
Colección con todos los correos electrónicos en este perfil establecidos como propiedades de tipo email
String
Nombre del cliente representado en el perfil.
String
Apellido del cliente representado en el perfil.
array
Colección con todas las listas de las que forma parte este perfil. Mostrar atributos
array
Una colección de todos los números de teléfono verificados o no verificados en este perfil establecidos como propiedades del tipo phone, enumerados en formato e164.
array
Array de hashes que representan los objetos de identidades del perfil. Por ejemplo números de teléfono, identidades de Mercado Libre. Mostrar atributos
Enum
El estado actual del perfil que indica si el perfil está suscrito explícitamente para recibir contenido promocional o no desea recibir ninguna comunicación promocional.
Valores enum posibles
unconfirmed Defecto
subscribed
unsubscribed
array
Una colección de todos los correos electrónicos verificados del perfil.
array
Una colección de todos los números de teléfono verificados del perfil.
{
  "id": "MzYwlE50",
  "type": "profile",
  "blocked": false,
  "created_at": 1665684173,
  "emails": [
    "will.e@acme.com"
  ],
  "first_name": "Will E",
  "last_name": "Coyote",
  "lists": [
    {
      "id": "zN4Xx4Km",
      "type": "list",
      "name": "Greens",
      "created_at": 1665684173
    }
  ],
  "phones": [
    "+59898000001"
  ],
  "properties": [
    {
      "id": "MQNKalb7",
      "kind": "address",
      "value": {
        "city": "Montevideo",
        "country": "UY",
        "latitude": "-0.349044168e2",
        "longitude": "-0.561370421e2",
        "notes": null,
        "postal_code": "11300",
        "region": "Departamento de Montevideo",
        "street": {
          "name": "Av. Luis Alberto de Herrera",
          "number": "1248"
        },
        "subregion": "CH"
      }
    },
    {
      "id": "MQNKalb7",
      "kind": "birthday",
      "name": null,
      "value": {
        "day": 3,
        "month": 11,
        "year": 1985
      }
    },
    {
      "id": "MQNKalb7",
      "kind": "email",
      "name": null,
      "value": "will.e@acme.com",
      "verified": true
    },
    {
      "id": "MQNKalb7",
      "kind": "phone",
      "name": null,
      "value": "+59898000001",
      "verified": true
    },
    {
      "id": "MQNKalb7",
      "kind": "gender",
      "name": null,
      "value": "male"
    }
  ],
  "state": "subscribed",
  "verified_emails": [
    "will.e@acme.com"
  ],
  "verified_phones": [
    "+59898000001"
  ]
}

Crear un perfil

Crea un nuevo perfil.

Parámetros
hash
Establezca la dirección para la propiedad address predeterminada. Puede pasar un objeto de dirección u, opcionalmente, proporcionar una cadena como address[suggest]. Al proporcionar la cadena de sugerencia, deconstruiremos la cadena y construiremos un objeto address a partir de ella.
String
Establece la dirección para la propiedad address con el nombre declarado entre corchetes. Por ejemplo, address[work]= configurará la dirección para la propiedad address con el nombre work. La propiedad se creará automáticamente para el perfil actual si aún no existe.
String
Establece la dirección de correo electrónico para la propiedad email predeterminada.
String
Establece la dirección de correo electrónico para la propiedad email con el nombre declarado entre corchetes. Por ejemplo, email[trabajo]= configurará el correo electrónico para la propiedad email con el nombre trabajo. La propiedad se creará automáticamente para el perfil actual si aún no existe.
String
Nombre del cliente representado en el perfil.
String
Apellido del cliente representado en el perfil.
array
Una colección de nombres de lista a la que se agregará este perfil. Se crearán nuevas listas cuando no existe una lista con este nombre
String
Establece el número de teléfono para la propiedad phone predeterminada. Espera un número en formato e164 o un número en formato local que se convertirá a e164 utilizando el país comercial como prefijo de país.
String
Establece el número de teléfono para la propiedad phone con el nombre declarado entre corchetes. Por ejemplo, phone[trabajo]= configurará el teléfono para la propiedad phone con el nombre trabajo. La propiedad se creará automáticamente para el perfil actual si aún no existe.
String
Establece un valor de propiedad pasando el nombre de la propiedad, por ejemplo property[Active]=true. Si la propiedad no tiene nombre, es posible hacer referencia a ella pasando su tipo como su nombre, es decir, property[gender]=male.
String
Establece un valor de propiedad pasando el id de la propiedad, por ejemplo, property[gVlpOkwJ]=MiValor.
Boolean
Utiliza el valor true para suscribir al cliente en la creación del perfil. Si el cliente ya otorgó el consentimiento para recibir comunicaciones promocionales de tu marca, puedes indicarlo de esta manera. El valor predeterminado es false, lo que significa que los nuevos perfiles no se suscriben automáticamente.
curl -X POST https://api.hellotext.com/v1/profiles 
 -d first_name="Will E" 
 -d last_name="Coyote" 
 -d phone="+59899000001" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "MzYwlE50"
}

Obtener un perfil

Obtener un perfil existente.

curl -G https://api.hellotext.com/v1/profiles/MzYwlE50 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Modificar un perfil

Modifica el perfil especificado con la información proporcionada.

Parámetros
hash
Establezca la dirección para la propiedad address predeterminada. Puede pasar un objeto de dirección u, opcionalmente, proporcionar una cadena como address[suggest]. Al proporcionar la cadena de sugerencia, deconstruiremos la cadena y construiremos un objeto address a partir de ella. Proporcionar un valor vacío elimina la dirección predeterminada del perfil. Por ejemplo, address='' o address={}.
String
Establece un valor de propiedad de dirección pasando la identificación de la propiedad, por ejemplo address[gVlpOkwJ]=MiValor. Pasar un valor vacío eliminará la dirección del perfil. Por ejemplo, address[gVlpOkwJ]='' eliminará la dirección con la identificación dada.
String
Establece la dirección para la propiedad address con el nombre declarado entre corchetes. Por ejemplo, address[work]= configurará la dirección para la propiedad address con el nombre work. La propiedad se creará automáticamente para el perfil actual si aún no existe. Pasar un valor vacío eliminará la dirección del perfil. Por ejemplo, address[work]='' eliminará la dirección work del perfil.
String
Establece la dirección de correo electrónico para la propiedad email predeterminada. Pasar un valor vacío eliminará el correo electrónico predeterminado, por ejemplo, email='' eliminará el correo electrónico predeterminado. Si el perfil tiene otros correos electrónicos, el segundo correo electrónico se marcará como el nuevo predeterminado.
String
Establezca un valor de propiedad de e-mail pasando la identificación de la propiedad, por ejemplo email[gVlpOkwJ]=will.e@acme.com. Pasar un valor vacío elimina el correo electrónico del perfil. Por ejemplo, email[gVlpOkwJ]='' eliminará el email del perfil.
String
Establece la dirección de correo electrónico para la propiedad email con el nombre declarado entre corchetes. Por ejemplo, email[trabajo]= configurará el correo electrónico para la propiedad email con el nombre trabajo. La propiedad se creará automáticamente para el perfil actual si aún no existe. Pasar un valor vacío elimina el correo electrónico del perfil. Por ejemplo, email[trabajo]='' eliminará el e-mail trabajo del perfil.
String
Nombre del cliente representado en el perfil.
String
Apellido del cliente representado en el perfil.
array
Una colección de nombres de a la que se agregará este perfil. Pasar una colección vacía [] se va eliminar el perfil de todas las listas.
hash
Nueva dirección predeterminada del perfil. Si está presente, reemplazará la dirección predeterminada y se convertirá en la nueva predeterminada. Sin eliminar la antigua dirección predeterminada.
String
Nuevo e-mail por defecto del perfil. Si está presente, reemplaza el e-mail por defecto y ser el e-mail defecto del perfil. Sin eliminarando el viejo e-mail defecto.
String
Nuevo teléfono por defecto del perfil. Si está presente, reemplaza el teléfono por defecto y ser el teléfono defecto del perfil. Sin eliminarando el viejo teléfono defecto.
String
Establece el número de teléfono para la propiedad phone predeterminada. Espera un número en formato e164 o un número en formato local que se convertirá a e164 utilizando el país comercial como prefijo de país. Pasar un valor vacío eliminará el teléfono predeterminado del perfil. Por ejemplo, phone='' eliminará el teléfono predeterminado del perfil. Si el perfil tiene otros números de teléfono, el segundo número de teléfono se marca como el nuevo predeterminado
String
Establezca un valor de propiedad de teléfono pasando la identificación de la propiedad, por ejemplo phone[gVlpOkwJ]=099888888. Pasar un valor vacío elimina el correo electrónico del perfil. Por ejemplo, phone[gVlpOkwJ]='' eliminará el phone del perfil.
String
Establece el número de teléfono para la propiedad phone con el nombre declarado entre corchetes. Por ejemplo, phone[trabajo]= configurará el teléfono para la propiedad phone con el nombre trabajo. La propiedad se creará automáticamente para el perfil actual si aún no existe Pasar un valor vacío elimina el teléfono del perfil. Por ejemplo, phone[trabajo]='' eliminará el teléfono trabajo del perfil.
String
Establece un valor de propiedad pasando el nombre de la propiedad, por ejemplo property[Active]=true. Si la propiedad no tiene nombre, es posible hacer referencia a ella pasando su tipo como su nombre, es decir, property[gender]=male.
String
Establece un valor de propiedad pasando el id de la propiedad, por ejemplo, property[gVlpOkwJ]=MiValor.
curl -X PATCH https://api.hellotext.com/v1/profiles/MzYwlE50 
 -d email="will.e@acme.com" 
 -d gender="male" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "MzYwlE50",
  "updated": true
}

Eliminar un perfil

Elimina el perfil especificado. Eliminar un perfil significa que todas sus propiedades serán eliminadas. Las conversaciones asociadas serán preservadas. Puedes restaurar el perfil una vez más a través del panel de control o la API cambiando el estado de suscripción del perfil a subscribed.

curl -X DELETE https://api.hellotext.com/v1/profiles/MzYwlE50 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "MzYwlE50",
  "type": "profile",
  "deleted": true
}

Listar todos los perfiles

Enumera los perfiles existentes ordenados por los más recientes. Los parámetros de paginación están disponibles en listas.

Parámetros
String
Limite el resultado a los perfiles que tienen el e-mail especificado.
String
Mostrar resultados listados antes (más recientes) que el id dado.
String
Limite los resultados a los perfiles que tienen el nombre especificado
String
Limite los resultados a los perfiles que tienen el apellido especificado
integer
Limitar cuántos resultados mostrar. El valor por defecto es 25. El máximo es 100.
Enum
El orden para clasificar los perfiles. Si se especifica un valor no válido, se utiliza el orden predeterminado.
Valores enum posibles
activity Defecto

Ordenar por la última fecha de actividad del perfil. Los perfiles con actividad más reciente aparecerán primero.

alphabetically

Ordenar por apellido, nombre.

created_at

Ordenar por la fecha de creación del perfil.

String
Limite el resultado a los perfiles que tienen el teléfono especificado.
String
Limite los resultados a los perfiles que tienen el valor de propiedad especificado.
String
Mostrar resultados listados después (más antiguos) que el id dado.
curl -G https://api.hellotext.com/v1/profiles 
 -d limit=5 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "profiles": [
    {
      "id": "MzYwlE50",
      "type": "profile",
      "blocked": false,
      "created_at": 1665684173,
      "emails": [
        "will.e@acme.com"
      ],
      "first_name": "Will E",
      "last_name": "Coyote",
      "lists": [
        {
          "id": "zN4Xx4Km",
          "type": "list",
          "name": "Greens",
          "created_at": 1665684173
        }
      ],
      "phones": [
        "+59898000001"
      ],
      "properties": [
        {
          "id": "MQNKalb7",
          "kind": "address",
          "value": {
            "city": "Montevideo",
            "country": "UY",
            "latitude": "-0.349044168e2",
            "longitude": "-0.561370421e2",
            "notes": null,
            "postal_code": "11300",
            "region": "Departamento de Montevideo",
            "street": {
              "name": "Av. Luis Alberto de Herrera",
              "number": "1248"
            },
            "subregion": "CH"
          }
        },
        {
          "id": "MQNKalb7",
          "kind": "birthday",
          "name": null,
          "value": {
            "day": 3,
            "month": 11,
            "year": 1985
          }
        },
        {
          "id": "MQNKalb7",
          "kind": "email",
          "name": null,
          "value": "will.e@acme.com",
          "verified": true
        },
        {
          "id": "MQNKalb7",
          "kind": "phone",
          "name": null,
          "value": "+59898000001",
          "verified": true
        },
        {
          "id": "MQNKalb7",
          "kind": "gender",
          "name": null,
          "value": "male"
        }
      ],
      "state": "subscribed",
      "verified_emails": [
        "will.e@acme.com"
      ],
      "verified_phones": [
        "+59898000001"
      ]
    },
    "{...}",
    "{...}"
  ]
}

Suscribir un perfil

Marca un perfil como suscrito para recibir comunicaciones promocionales de tu marca.

curl -X POST https://api.hellotext.com/v1/profiles/MzYwlE50/subscribe 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "MzYwlE50",
  "type": "profile",
  "blocked": false,
  "created_at": 1665684173,
  "emails": [
    "will.e@acme.com"
  ],
  "first_name": "Will E",
  "last_name": "Coyote",
  "lists": [
    {
      "id": "zN4Xx4Km",
      "type": "list",
      "name": "Greens",
      "created_at": 1665684173
    }
  ],
  "phones": [
    "+59898000001"
  ],
  "properties": [
    {
      "id": "MQNKalb7",
      "kind": "address",
      "value": {
        "city": "Montevideo",
        "country": "UY",
        "latitude": "-0.349044168e2",
        "longitude": "-0.561370421e2",
        "notes": null,
        "postal_code": "11300",
        "region": "Departamento de Montevideo",
        "street": {
          "name": "Av. Luis Alberto de Herrera",
          "number": "1248"
        },
        "subregion": "CH"
      }
    },
    {
      "id": "MQNKalb7",
      "kind": "birthday",
      "name": null,
      "value": {
        "day": 3,
        "month": 11,
        "year": 1985
      }
    },
    {
      "id": "MQNKalb7",
      "kind": "email",
      "name": null,
      "value": "will.e@acme.com",
      "verified": true
    },
    {
      "id": "MQNKalb7",
      "kind": "phone",
      "name": null,
      "value": "+59898000001",
      "verified": true
    },
    {
      "id": "MQNKalb7",
      "kind": "gender",
      "name": null,
      "value": "male"
    }
  ],
  "state": "subscribed",
  "verified_emails": [
    "will.e@acme.com"
  ],
  "verified_phones": [
    "+59898000001"
  ]
}

Desuscribir un perfil

Cancela la suscripción de un perfil para recibir futuras comunicaciones promocionales de tu marca.

curl -X POST https://api.hellotext.com/v1/profiles/MzYwlE50/unsubscribe 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "MzYwlE50",
  "type": "profile",
  "blocked": false,
  "created_at": 1665684173,
  "emails": [
    "will.e@acme.com"
  ],
  "first_name": "Will E",
  "last_name": "Coyote",
  "lists": [
    {
      "id": "zN4Xx4Km",
      "type": "list",
      "name": "Greens",
      "created_at": 1665684173
    }
  ],
  "phones": [
    "+59898000001"
  ],
  "properties": [
    {
      "id": "MQNKalb7",
      "kind": "address",
      "value": {
        "city": "Montevideo",
        "country": "UY",
        "latitude": "-0.349044168e2",
        "longitude": "-0.561370421e2",
        "notes": null,
        "postal_code": "11300",
        "region": "Departamento de Montevideo",
        "street": {
          "name": "Av. Luis Alberto de Herrera",
          "number": "1248"
        },
        "subregion": "CH"
      }
    },
    {
      "id": "MQNKalb7",
      "kind": "birthday",
      "name": null,
      "value": {
        "day": 3,
        "month": 11,
        "year": 1985
      }
    },
    {
      "id": "MQNKalb7",
      "kind": "email",
      "name": null,
      "value": "will.e@acme.com",
      "verified": true
    },
    {
      "id": "MQNKalb7",
      "kind": "phone",
      "name": null,
      "value": "+59898000001",
      "verified": true
    },
    {
      "id": "MQNKalb7",
      "kind": "gender",
      "name": null,
      "value": "male"
    }
  ],
  "state": "unsubscribed",
  "verified_emails": [
    "will.e@acme.com"
  ],
  "verified_phones": [
    "+59898000001"
  ]
}

Verificar la información de contacto de un perfil

Verifica la información de contacto de un perfil para asegurar que la información haya sido verificada y evitar suplantaciones.

curl -X POST https://api.hellotext.com/v1/profiles/MzYwlE50/verify 
 -d phone="+598000000" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "verified": true
}
curl -X POST https://api.hellotext.com/v1/profiles/MzYwlE50/verify 
 -d email="will.e@acme.com" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "verified": true
}

Desverificar la información de contacto de un perfil

curl -X DELETE https://api.hellotext.com/v1/profiles/MzYwlE50/verify 
 -d phone="+598000000" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "verified": false
}
curl -X DELETE https://api.hellotext.com/v1/profiles/MzYwlE50/verify 
 -d email="will.e@acme.com" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "verified": false
}

Propiedades

Las propiedades son los atributos de perfiles como teléfono, correo electrónico, empresa, género, fecha de nacimiento y dirección.

Puedes crear propiedades personalizadas para cualquier necesidad específica simplemente eligiendo su tipo y un nombre opcional. Cada tipo de propiedad espera su valor con una estructura específico. Para más información, revisa detallado de cada formato a continuación.

Una vez que creadas, las nuevas propiedades están disponibles de inmediato en todos los perfiles nuevos y existentes.

phone, email, mercadolibre propiedades están agrupadas juntas y mostradas antes de todas las propeidades otras, en el orden mencionado. Por lo tanto, su posición refleja solo el orden dentro de su propia especie.

  • POST

    v1/properties

  • GET

    v1/properties/:id

  • PATCH

    v1/properties/:id

  • DELETE

    v1/properties/:id

  • GET

    v1/properties

El objeto de propiedad

Atributos
id
String
Identificador único del objeto.
Type
Tipo de objeto. Esto es siempre property.
Epoch
Fecha de creación del objeto.
String
Nombre opcional de la propiedad.
integer
Posición numérica de la propiedad en relación a otras para establecer el orden.
profile
Id del perfil al que pertenece esta propiedad.
Boolean
¿Es la propiedad única o no? Por defecto es false. La singularidad de la propiedad determina si varios perfiles pueden tener el mismo valor. Las propiedades únicas aseguran que no haya dos perfiles con el mismo valor. Esto es útil en casos en los que deseas que un solo perfil tenga un valor específico en un momento determinado.
Aparte de los tipos mencionados a continuación, todos los demás tipos pueden configurarse como únicos, las actualizaciones a estas propiedades que apuntan al atributo unique son ignoradas.
No se puede configurar como único.
birthday
checkbox
date
gender
list
tags
{
  "id": "OBYBnY69",
  "type": "property",
  "created_at": 1665684173,
  "kind": "text",
  "name": "My Property",
  "position": 8,
  "profile": null,
  "unique": false
}

Clases de propiedades

Las propiedades tienen diferentes formatos para sus valores dependiendo de su clase, expresado con el atributo kind.

Cada tipo de kind espera un formato específico como su valor. Consulte la descripción de cada uno a continuación.

Los valores de las propiedades siempre se establecen desde el objeto de perfil.

La propiedad address

Representa una dirección asociada a un perfil. Puede ayudar a realizar un seguimiento de las direcciones de los clientes. El uso de esta propiedad facilita la segmentación de clientes en regiones, calles o países específicos.

Atributos
id
String
Identificador del objeto propiedad.
String
El formato de la propiedad, siempre es address.
hash
Un objeto que contiene la información de la dirección. Mostrar atributos
{
  "id": "MQNKalb7",
  "kind": "address",
  "value": {
    "city": "Montevideo",
    "country": "UY",
    "latitude": "-0.349044168e2",
    "longitude": "-0.561370421e2",
    "notes": null,
    "postal_code": "11300",
    "region": "Departamento de Montevideo",
    "street": {
      "name": "Av. Luis Alberto de Herrera",
      "number": "1248"
    },
    "subregion": "CH"
  }
}

La propiedad birthday

La propiedad birthday se basa en la propiedad date y hereda su estructura. Tiene un nombre diferente ya que esta ideada específicamente para realizar un seguimiento de la fecha de cumpleaños del perfil. El uso de esta propiedad facilita la segmentación de clientes por edad o día del mes cuando se utilizan Segmentos o Trayectos.

Atributos
id
String
Identificador único del objeto.
String
El formato de la propiedad, esto es siempre birthday.
hash
Este hash representa una fecha. Es posible completar parcialmente con la información disponible. Por ejemplo, solo se puede ingresar el año de nacimiento o el día y el mes. Mostrar atributos
{
  "id": "MQNKalb7",
  "kind": "birthday",
  "name": null,
  "value": {
    "day": 3,
    "month": 11,
    "year": 1985
  }
}

La propiedad checkbox

Atributos
id
String
Identificador único del objeto.
String
El formato de la propiedad, siempre es checkbox.
Boolean
Espera true o false. Por defecto es false.
{
  "id": "MQNKalb7",
  "kind": "checkbox",
  "name": null,
  "value": false
}

La propiedad company

Atributos
id
String
Identificador único del objeto.
String
El formato de la propiedad, esto siempre es company.
String
Representa el nombre de una empresa. Puede ser utilizado para almacenar el nombre de la empresa con la que está asociado el perfil.
{
  "id": "MQNKalb7",
  "kind": "company",
  "name": null,
  "value": "ACME Corporation"
}

La propiedad date

Atributos
id
String
Identificador único del objeto.
String
El formato de la propiedad, esto es siempre date.
hash
Este hash representa una fecha. Es posible completar parcialmente con la información disponible. Por ejemplo, solo se puede ingresar el año de nacimiento o el día y el mes. Mostrar atributos
{
  "id": "MQNKalb7",
  "kind": "date",
  "name": null,
  "value": {
    "day": 3,
    "month": 11,
    "year": 1985
  }
}

La propiedad email

Atributos
id
String
Identificador único del objeto.
String
El formato de la propiedad, esto siempre es email.
String
Representa una dirección de correo electrónico. Puede ser utilizado para almacenar la dirección de correo electrónico del perfil.
{
  "id": "MQNKalb7",
  "kind": "email",
  "name": null,
  "value": "will.e@acme.com",
  "verified": true
}

La propiedad gender

Atributos
id
String
Identificador único del objeto.
String
El formato de la propiedad, esto siempre es gender.
String
Valor que representa el género del perfil. Utilice masculino para hombre y femenino para mujer. Utilice cualquier otro valor para representar otros géneros.
{
  "id": "MQNKalb7",
  "kind": "gender",
  "name": null,
  "value": "male"
}

La propiedad mercadolibre

Atributos
id
String
Identificador único del objeto.
String
The format of the property, this is always mercadolibre.
String
Represents the username of a MercadoLibre user.
{
  "id": "MQNKalb7",
  "kind": "mercadolibre",
  "name": null,
  "value": "WILLE900001"
}

La propiedad number

Atributos
id
String
Identificador único del objeto.
String
El formato de la propiedad, esto siempre es number.
float
Representa un número. Puede ser utilizado para almacenar cualquier valor numérico.
{
  "id": "MQNKalb7",
  "kind": "number",
  "name": null,
  "value": 29.99
}

La propiedad phone

Atributos
id
String
Identificador único del objeto.
String
El formato de la propiedad, esto siempre es phone.
String
Representa un número de teléfono. Puede ser utilizado para almacenar el número de teléfono del perfil.
{
  "id": "MQNKalb7",
  "kind": "phone",
  "name": null,
  "value": "+59898000001",
  "verified": true
}

La propiedad tags

Atributos
id
String
Identificador único del objeto.
String
El formato de la propiedad. Siempre es tags.
array
Representa una colección de etiquetas.
{
  "id": "MQNKalb7",
  "kind": "tags",
  "name": null,
  "value": [
    "tag1",
    "tag2"
  ]
}

La propiedad text

Atributos
id
String
Identificador único del objeto.
String
El formato de la propiedad, esto siempre es text.
String
Representa cualquier texto especificado. Puede ser utilizado para notas sobre el perfil o para almacenar cualquier metadato específico del negocio
{
  "id": "MQNKalb7",
  "kind": "text",
  "name": null,
  "value": "Long lasting customer"
}

La propiedad url

Atributos
id
String
Identificador único del objeto.
String
El formato de la propiedad, esto siempre es url.
String
Representa una URL. Puede ser utilizado para almacenar un enlace a un sitio web o cualquier otro recurso web.
{
  "id": "MQNKalb7",
  "kind": "url",
  "name": null,
  "value": "https://www.hellotext.com"
}

Crear una propiedad

Crea una nueva propiedad.

Parámetros
Enum
Requerido
El formato de la propiedad.
Valores enum posibles
address
email
phone
checkbox
date
number
tags
text
url
String
El nombre de la propiedad. Se aplican ciertas restricciones al nombre de la propiedad cuando se establece:
  • - El nombre no puede estar duplicado.
  • - El nombre no puede comenzar con un número. Por ejemplo, 1er-nombre es inválido.
  • - El nombre no puede contener llaves. Por ejemplo, {nombre} es inválido.
integer
Las nuevas propiedades obtienen el último número de posición si no se especifica. Si se da una posición diferente, las propiedades existentes actualizarán sus posiciones para establecer el nuevo orden. Los valores aceptados deben ser mayores que cero.
profile
Id del perfil al que pertenece esta propiedad. Si se especifica, la propiedad solo estará disponible para el perfil especificado y no será visible para otros. Solo se puede asignar a address, email o phone. Requerido al crear propiedades de tipo address, email o phone.
Boolean
¿Es la propiedad única o no? Por defecto es false. La singularidad de la propiedad determina si varios perfiles pueden tener el mismo valor. Las propiedades únicas aseguran que no haya dos perfiles con el mismo valor. Esto es útil en casos en los que deseas que un solo perfil tenga un valor específico en un momento determinado.
curl -X POST https://api.hellotext.com/v1/properties 
 -d profile="OBYBnY69" 
 -d kind="text" 
 -d name="My Property" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "OBYBnY69",
  "type": "property",
  "created_at": 1665684173,
  "kind": "text",
  "name": "My Property",
  "position": 8,
  "profile": "OBYBnY69",
  "unique": false
}

Obtener una propiedad

Obtener una propiedad existente.

curl -G https://api.hellotext.com/v1/properties/OBYBnY69 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Modificar una propiedad

Modifica la propiedad especificada con la información proporcionada.

Parámetros
String
El nombre de la propiedad. Se aplican ciertas restricciones al nombre de la propiedad cuando se establece:
  • - El nombre no puede estar duplicado.
  • - El nombre no puede comenzar con un número. Por ejemplo, 1er-nombre es inválido.
  • - El nombre no puede contener llaves. Por ejemplo, {nombre} es inválido.
integer
Las nuevas propiedades obtienen el último número de posición si no se especifica. Si se da una posición diferente, las propiedades existentes actualizarán sus posiciones para establecer el nuevo orden. Los valores aceptados deben ser mayores que cero. Proporcionar un valor vacío position='' mueve la propiedad al final de la lista de propiedades.
Boolean
Cambia la singularidad de la propiedad. Convertir una propiedad no única en única fallará si varios perfiles tienen el mismo valor. En estos casos, debes resolver el conflicto antes de continuar para hacer que la propiedad sea única.
curl -X PATCH https://api.hellotext.com/v1/properties/:id 
 -d name="My Renamed Property" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "OBYBnY69",
  "type": "property",
  "created_at": 1665684173,
  "kind": "text",
  "name": "My Renamed Property",
  "position": 8,
  "profile": null,
  "unique": false
}

Eliminar una propiedad

Elimina permanentemente la propiedad especificada.

curl -X DELETE https://api.hellotext.com/v1/properties/OBYBnY69 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "OBYBnY69",
  "type": "property",
  "deleted": true
}

Listar todas las propiedades

Enumera las propiedades existentes ordenadas por las más recientes. Los parámetros de paginación están disponibles en listas.

Parámetros
String
Mostrar resultados listados antes (más recientes) que el id dado.
integer
Limitar cuántos resultados mostrar. El valor por defecto es 25. El máximo es 100.
profile
Identificador único del perfil.
String
Mostrar resultados listados después (más antiguos) que el id dado.
curl -G https://api.hellotext.com/v1/properties 
 -d limit=5 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "properties": [
    {
      "id": "OBYBnY69",
      "type": "property",
      "created_at": 1665684173,
      "kind": "text",
      "name": "My Property",
      "position": 8,
      "profile": null,
      "unique": false
    },
    "{...}",
    "{...}"
  ]
}

Listas

Las listas actúan como agrupación lógica de perfiles.

  • POST

    v1/lists

  • GET

    v1/lists/:id

  • PATCH

    v1/lists/:id

  • DELETE

    v1/lists/:id

  • GET

    v1/lists

El objecto de la lista

Atributos
id
String
Identificador único del objeto.
Type
Tipo de objeto. Esto es siempre list.
Epoch
Fecha de creación del objeto.
String
Nombre de la lista.
{
  "id": "zN4Xx4Km",
  "type": "list",
  "name": "Greens",
  "created_at": 1665684173
}

Crear una lista

Crea una nueva lista

Parámetros
String
Requerido
Nombre de la lista, distingue mayúsculas y minúsculas. No se permiten nombres duplicados.
curl -X POST https://api.hellotext.com/v1/lists 
 -d name="Beauty & Care" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "zN4Xx4Km",
  "type": "list",
  "name": "Beauty & Care",
  "created_at": 1665684173
}

Obtener una lista

Recupera una lista existente. Puedes especificar la lista a través de sus atributos id o name.

curl -G https://api.hellotext.com/v1/lists/zN4Xx4Km 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Modificar una lista

Actualiza una lista existente. Puedes actualizar una lista a través de sus atributos id o name.

Parámetros
String
Requerido
Nombre de la lista, distingue mayúsculas y minúsculas. No se permiten nombres duplicados.
curl -X PATCH https://api.hellotext.com/v1/lists/zN4Xx4Km 
 -d name="Loyal customers" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "zN4Xx4Km",
  "type": "list",
  "name": "Loyal customers",
  "created_at": 1665684173
}

Eliminar una lista

Elimina una lista existente. Puedes eliminar una lista a través de sus atributos id o name.

curl -X DELETE https://api.hellotext.com/v1/lists/zN4Xx4Km 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "zN4Xx4Km",
  "type": "list",
  "deleted": true
}

Listar todas las listas

Enumera las listas existentes ordenados por los más recientes. Los parámetros de paginación están disponibles en listas.

Parámetros
String
Mostrar resultados listados antes (más recientes) que el id dado.
integer
Limitar cuántos resultados mostrar. El valor por defecto es 25. El máximo es 100.
String
Mostrar listas cuyo nombre empiece con el valor proporcionado
String
Mostrar resultados listados después (más antiguos) que el id dado.
curl -G https://api.hellotext.com/v1/lists 
 -d limit=5 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "lists": [
    {
      "id": "zN4Xx4Km",
      "type": "list",
      "name": "Greens",
      "created_at": 1665684173
    },
    "{...}",
    "{...}"
  ]
}

Agregar perfil a la lista

Agrega un perfil a una lista si el perfil no está ya en la lista. Puedes especificar la lista a través de sus atributos id o name.

curl -X POST https://api.hellotext.com/v1/lists/dWJ8VYmz/profiles/MzYwlE50 \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "MzYwlE50",
  "type": "profile",
  "blocked": false,
  "created_at": 1665684173,
  "emails": [
    "will.e@acme.com"
  ],
  "first_name": "Will E",
  "last_name": "Coyote",
  "lists": [
    {
      "id": "zN4Xx4Km",
      "type": "list",
      "name": "Greens",
      "created_at": 1665684173
    }
  ],
  "phones": [
    "+59898000001"
  ],
  "properties": [
    {
      "id": "MQNKalb7",
      "kind": "address",
      "value": {
        "city": "Montevideo",
        "country": "UY",
        "latitude": "-0.349044168e2",
        "longitude": "-0.561370421e2",
        "notes": null,
        "postal_code": "11300",
        "region": "Departamento de Montevideo",
        "street": {
          "name": "Av. Luis Alberto de Herrera",
          "number": "1248"
        },
        "subregion": "CH"
      }
    },
    {
      "id": "MQNKalb7",
      "kind": "birthday",
      "name": null,
      "value": {
        "day": 3,
        "month": 11,
        "year": 1985
      }
    },
    {
      "id": "MQNKalb7",
      "kind": "email",
      "name": null,
      "value": "will.e@acme.com",
      "verified": true
    },
    {
      "id": "MQNKalb7",
      "kind": "phone",
      "name": null,
      "value": "+59898000001",
      "verified": true
    },
    {
      "id": "MQNKalb7",
      "kind": "gender",
      "name": null,
      "value": "male"
    }
  ],
  "state": "subscribed",
  "verified_emails": [
    "will.e@acme.com"
  ],
  "verified_phones": [
    "+59898000001"
  ]
}

Eliminar perfil de la lista

Elimina un perfil de una lista si el perfil es miembro de la lista. Puedes especificar la lista a través de sus atributos id o name.

curl -X DELETE https://api.hellotext.com/v1/lists/dWJ8VYmz/profiles/MzYwlE50 \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "MzYwlE50",
  "type": "profile",
  "blocked": false,
  "created_at": 1665684173,
  "emails": [
    "will.e@acme.com"
  ],
  "first_name": "Will E",
  "last_name": "Coyote",
  "lists": [

  ],
  "phones": [
    "+59898000001"
  ],
  "properties": [
    {
      "id": "MQNKalb7",
      "kind": "address",
      "value": {
        "city": "Montevideo",
        "country": "UY",
        "latitude": "-0.349044168e2",
        "longitude": "-0.561370421e2",
        "notes": null,
        "postal_code": "11300",
        "region": "Departamento de Montevideo",
        "street": {
          "name": "Av. Luis Alberto de Herrera",
          "number": "1248"
        },
        "subregion": "CH"
      }
    },
    {
      "id": "MQNKalb7",
      "kind": "birthday",
      "name": null,
      "value": {
        "day": 3,
        "month": 11,
        "year": 1985
      }
    },
    {
      "id": "MQNKalb7",
      "kind": "email",
      "name": null,
      "value": "will.e@acme.com",
      "verified": true
    },
    {
      "id": "MQNKalb7",
      "kind": "phone",
      "name": null,
      "value": "+59898000001",
      "verified": true
    },
    {
      "id": "MQNKalb7",
      "kind": "gender",
      "name": null,
      "value": "male"
    }
  ],
  "state": "subscribed",
  "verified_emails": [
    "will.e@acme.com"
  ],
  "verified_phones": [
    "+59898000001"
  ]
}

Cupones

Importa los cupones de tu eCommerce que te gustaría enviar en tus campañas promocionales. Puedes medir los resultados de los diferentes cupones.

  • POST

    v1/coupons

  • GET

    v1/coupons/:id

  • PATCH

    v1/coupons/:id

  • DELETE

    v1/coupons/:id

  • GET

    v1/coupons

El objeto del cupón

Atributos
id
String
Identificador único del objeto.
Type
Tipo de objeto. Esto es siempre coupon.
String
Código canjeable del cupón. Este es el nombre del cupón que ve el cliente, es decir, SALE.
Epoch
Fecha de creación del objeto.
String
Descripción del cupón. Disponible como una etiqueta para ser utilizada en los mensajes.
URL
URL para canjear el cupón.
String
El número de cupón o el identificador original de la fuente externa que creó el cupón.
{
  "id": "xJEOaPdk",
  "type": "coupon",
  "code": "SALE",
  "created_at": 1665684173,
  "description": "Get 15% off all our summer sale",
  "destination_url": "https://www.myshop.com/redeem/SALE",
  "reference": null
}

Crear un cupón

Crea un nuevo cupón.

Parámetros
String
Requerido
Código canjeable del cupón. Este es el nombre del cupón que ve el cliente, es decir, SALE. Distingue mayúsculas y minúsculas. No se permiten códigos duplicados.
String
Requerido
Descripción del cupón. Disponible como una etiqueta para ser utilizada en los mensajes.
URL
Requerido
URL para canjear el cupón.
String
El número de cupón o el identificador original de la fuente externa que creó el cupón.
curl -X POST https://api.hellotext.com/v1/coupons 
 -d code="SALE" 
 -d description="Get 15% off all our summer sale" 
 -d destination_url="https://www.myshop.com/redeem/SALE" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "xJEOaPdk",
  "type": "coupon",
  "code": "SALE",
  "created_at": 1665684173,
  "description": "Get 15% off all our summer sale",
  "destination_url": "https://www.myshop.com/redeem/SALE",
  "reference": null
}

Obtener un cupón

Obtener un cupón existente.

curl -G https://api.hellotext.com/v1/coupons/xJEOaPdk 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Modificar un cupón

Modifica el cupón especificado con la información proporcionada.

Parámetros
String
Requerido
Código canjeable del cupón. Este es el nombre del cupón que ve el cliente, es decir, SALE. Distingue mayúsculas y minúsculas. No se permiten códigos duplicados.
String
Requerido
Descripción del cupón. Disponible como una etiqueta para ser utilizada en los mensajes.
URL
Requerido
URL para canjear el cupón.
String
El número de cupón o el identificador original de la fuente externa que creó el cupón.
curl -X PATCH https://api.hellotext.com/v1/coupons/xJEOaPdk 
 -d code="SALE15" 
 -d description="Get 15% off all our summer sale" 
 -d destination_url="https://www.myshop.com/redeem/SALE" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "xJEOaPdk",
  "type": "coupon",
  "code": "SALE15",
  "created_at": 1665684173,
  "description": "Get 15% off all our summer sale",
  "destination_url": "https://www.myshop.com/redeem/SALE",
  "reference": null
}

Eliminar un cupón

Elimina permanentemente el cupón especificado.

curl -X DELETE https://api.hellotext.com/v1/coupons/xJEOaPdk 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "xJEOaPdk",
  "type": "coupon",
  "deleted": true
}

Listar todos los cupones

Enumera los cupones existentes ordenados por los más recientes. Los parámetros de paginación están disponibles en listas.

Parámetros
String
Mostrar resultados listados antes (más recientes) que el id dado.
integer
Limitar cuántos resultados mostrar. El valor por defecto es 25. El máximo es 100.
String
Mostrar resultados listados después (más antiguos) que el id dado.
curl -G https://api.hellotext.com/v1/coupons 
 -d limit=5 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "coupons": [
    {
      "id": "xJEOaPdk",
      "type": "coupon",
      "code": "SALE",
      "created_at": 1665684173,
      "description": "Get 15% off all our summer sale",
      "destination_url": "https://www.myshop.com/redeem/SALE",
      "reference": null
    },
    "{...}",
    "{...}"
  ]
}

Seguimiento

El seguimiento de las interacciones de los clientes abre nuevas posibilidades de marketing y brinda a las empresas una vista completa del historial de cada cliente.

Mediante el seguimiento de las acciones de clientes, es posible crear audiencias segmentadas basadas en lo que hacen y les gusta, y usar esto para marketing de alta precisión. Las empresas pueden activar automatizaciones basadas en la actividad del cliente y dar a su equipo una gran ventaja encontrando nuevas oportunidades para interactuar activamente y vender más.

Una configuración mínima para realizar un seguimiento de un evento es establecer el parámetro action con cualquiera de las acciones pre-definidas o personalizadas (consulta Acciones) y el parámetro profile que representa el perfil del cliente o el session si el seguimiento de eventos se realiza a partir de enlaces cortos en campañas o rutas (ver Sesiones).

Al proporcionar los parámetros session y profile, asegúrese de que la sesión esté asignada al perfil. Las sesiones asignadas a un perfil no se pueden utilizar para realizar un seguimiento de los eventos de otro perfil. Si la sesión no está asignada a ningún perfil, se asignará automáticamente al perfil que pase al realizar el seguimiento de un evento.

Al proporcionar una currency. Se debe especificar el amount. Si no se proporciona ninguno, los valores se heredarán del trackable si el objeto tiene los atributos.

  POST /v1/attribution/events

Eventos de app

Realiza un seguimiento de los eventos importantes realizados por tus clientes cuando interactúan con tu aplicación. Las acciones más comunes incluyen cuando una aplicación se instala con la acción app.installed, se elimina con app.removed o cuando un usuario gasta una determinada cantidad con app.spent.

Al rastrear eventos asociados a sesiones creadas después de una campaña, todos los valores de atribución, incluidos los valores monetarios, se agregarán a los informes de la campaña.

Parámetros
enum
Requerido
El nombre de la acción a rastrear. Los valores posibles son app.spent, app.installed y app.removed.
Valores enum posibles
app.installed
app.removed
app.spent
float
Monto monetario que representa los ingresos asociados a este evento rastreado. El valor predeterminado es null. Obligatorio si action=app.spent.
app
string
Requerido
Identificador único del objeto de aplicación al que está asociado este evento.
hash
Se puede pasar un hash en lugar del parámetro app. El app se va agregar y despues rastreado. Mostrar atributos
currency
Moneda para el cantidad proporcionada en formato ISO 4217. El valor predeterminado siempre es USD. Obligatorio si action=app.spent.
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Obligatorio si no se especifica session. Identificador único del objeto de perfil al que pertenece este evento. Si no se especifica explícitamente, el identificador de perfil se puede heredar cuando se especifica el parámetro session y la sesión ya está asociada a un perfil o se adjunta posteriormente a uno.
string
Obligatorio si no se especifica profile. Identificador del objeto de sesión al que pertenece este evento. Las sesiones son identificadores generados automáticamente a partir de los clics de los visitantes en enlaces cortos o de la librería Hellotext.js al realizar seguimientos de visitantes anónimos. Es una forma de rastrear eventos en el lado del cliente sin autenticar o revelar el identificador del perfil, lo que permite asociarlo más tarde a un perfil de forma segura en el lado del servidor. Más información sobre Sesiones.
epoch
Fecha original en que ocurrió el evento. Esto es útil si desea registrar un evento que sucedió en el pasado. Si no se proporciona ningún valor, su valor será el mismo de created_at.
url
url
El URL de la pagína este evento se occuro.
curl https://api.hellotext.com/v1/attribution/events \
  -d action="app.installed" \
  -d app=xnqJQ47v \
  -d session=2KAGgAgm \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "status": "received"
}

Eventos de carrito

Realiza un seguimiento de los eventos realizados por los clientes cuando agregan o eliminan elementos de su carrito de compras. O abandonan el carrito

Los valores monetarios asociados a los elementos del carrito se agregarán a los informes de la campaña.

Parámetros
enum
Requerido
Un hash que representa el objeto de acción.
Valores enum posibles
cart.abandoned
cart.added
cart.removed
float
Monto monetario que representa los ingresos asociados a este evento. El valor predeterminado es null.
string
El identificador del objeto Cart. Requerido cuando la acción es cart.abandoned.
currency
Moneda para el cantidad proporcionada en formato ISO 4217. El valor predeterminado siempre es USD.
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Una colección de productos incluidos en el carrito. Puede ser una combinación de identificadores de productos o variantes de productos (id, reference o sku) y product_parameters y product_variant_parameters. Requerido cuando la acción es cart.added o cart.removed.

Cuando no se proporciona un objeto Carrito, se creará automáticamente un objeto Carrito y los productos se agregarán a él. Cuando se proporciona un objeto Carrito, los productos se agregarán al Carrito. Y los productos se mostrarán en la Trayectoria de Actividad del Perfil.

Asegúrate de establecer la reference o sku para el producto o la variante del producto para evitar la creación de productos duplicados.
string
Obligatorio si no se especifica session. Identificador único del objeto de perfil al que pertenece este evento. Si no se especifica explícitamente, el identificador de perfil se puede heredar cuando se especifica el parámetro session y la sesión ya está asociada a un perfil o se adjunta posteriormente a uno.
string
Obligatorio si no se especifica profile. Identificador del objeto de sesión al que pertenece este evento. Las sesiones son identificadores generados automáticamente a partir de los clics de los visitantes en enlaces cortos o de la librería Hellotext.js al realizar seguimientos de visitantes anónimos. Es una forma de rastrear eventos en el lado del cliente sin autenticar o revelar el identificador del perfil, lo que permite asociarlo más tarde a un perfil de forma segura en el lado del servidor. Más información sobre Sesiones.
epoch
Fecha original en que ocurrió el evento. Esto es útil si desea registrar un evento que sucedió en el pasado. Si no se proporciona ningún valor, su valor será el mismo de created_at.
url
url
El URL de la pagína este evento se occuro.
curl https://api.hellotext.com/v1/attribution/events \
  -d action="cart.added" \
  -d app=xnqJQ47v \
  -d session=2KAGgAgm \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "status": "received"
}

Eventos de cupones

Realiza un seguimiento de los eventos realizados por tus clientes cuando canjean cupones. El valor disponible es coupon.redeemed para los cupones canjeados.

Los valores monetarios asociados al canje de cupones se agregarán a los informes de la campaña.

Parámetros
enum
Requerido
El nombre de la acción a rastrear.
Valores enum posibles
coupon.redeemed
float
Monto monetario que representa los ingresos asociados a este evento. El valor predeterminado es null.
string
Requerido
Identificador único del objeto del cupón al que está asociado este evento.
hash
Se puede pasar un hash en lugar del parámetro coupon. El cupon se va agregar y despues rastreado. Mostrar atributos
currency
Moneda para el cantidad proporcionada en formato ISO 4217. El valor predeterminado siempre es USD.
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Obligatorio si no se especifica session. Identificador único del objeto de perfil al que pertenece este evento. Si no se especifica explícitamente, el identificador de perfil se puede heredar cuando se especifica el parámetro session y la sesión ya está asociada a un perfil o se adjunta posteriormente a uno.
string
Obligatorio si no se especifica profile. Identificador del objeto de sesión al que pertenece este evento. Las sesiones son identificadores generados automáticamente a partir de los clics de los visitantes en enlaces cortos o de la librería Hellotext.js al realizar seguimientos de visitantes anónimos. Es una forma de rastrear eventos en el lado del cliente sin autenticar o revelar el identificador del perfil, lo que permite asociarlo más tarde a un perfil de forma segura en el lado del servidor. Más información sobre Sesiones.
epoch
Fecha original en que ocurrió el evento. Esto es útil si desea registrar un evento que sucedió en el pasado. Si no se proporciona ningún valor, su valor será el mismo de created_at.
url
url
El URL de la pagína este evento se occuro.
curl https://api.hellotext.com/v1/attribution/events \
  -d action="coupon.redeemed" \
  -d coupon=wx4Vn4no \
  -d session=2KAGgAgm \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "status": "received"
}

Eventos de formularios

Realiza un seguimiento de los eventos realizados por tus clientes cuando completan un formulario. Las acciones disponibles son form.completed.

Los valores monetarios asociados a la finalización del formulario se agregarán a los informes de la campaña.

Parámetros
enum
Requerido
El nombre de la acción a rastrear.
Valores enum posibles
form.completed
float
Monto monetario que representa los ingresos asociados a este evento. El valor predeterminado es null.
currency
Moneda para el cantidad proporcionada en formato ISO 4217. El valor predeterminado siempre es USD.
string
Requerido
Identificador único del objeto de formulario al que está asociado este evento.
hash
Se puede pasar un hash en lugar del parámetro form. El formulario se va agregar y despues rastreado. Mostrar atributos
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Obligatorio si no se especifica session. Identificador único del objeto de perfil al que pertenece este evento. Si no se especifica explícitamente, el identificador de perfil se puede heredar cuando se especifica el parámetro session y la sesión ya está asociada a un perfil o se adjunta posteriormente a uno.
string
Obligatorio si no se especifica profile. Identificador del objeto de sesión al que pertenece este evento. Las sesiones son identificadores generados automáticamente a partir de los clics de los visitantes en enlaces cortos o de la librería Hellotext.js al realizar seguimientos de visitantes anónimos. Es una forma de rastrear eventos en el lado del cliente sin autenticar o revelar el identificador del perfil, lo que permite asociarlo más tarde a un perfil de forma segura en el lado del servidor. Más información sobre Sesiones.
epoch
Fecha original en que ocurrió el evento. Esto es útil si desea registrar un evento que sucedió en el pasado. Si no se proporciona ningún valor, su valor será el mismo de created_at.
url
url
El URL de la pagína este evento se occuro.
curl https://api.hellotext.com/v1/attribution/events \
  -d action="form.completed" \
  -d form=wx4Vn4no \
  -d session=2KAGgAgm \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "status": "received"
}

Eventos de órdenes

Realiza un seguimiento de los eventos relacionados con el ciclo de vida de las ordenes de tus clientes. Las acciones disponibles son order.placed cuando un cliente realiza una orden, order.confirmed cuando se confirma, order.cancelled si se cancela y < code>order.shipped cuando se envía.

Los valores monetarios asociados a las órdenes se agregarán a los informes de la campaña.

Parámetros
enum
Requerido
El nombre de la acción a rastrear.
Valores enum posibles
order.cancelled
order.confirmed
order.delivered
order.placed
order.printed_label
order.shipped
float
Monto monetario que representa los ingresos asociados a este evento. El valor predeterminado es null.
currency
Moneda para el cantidad proporcionada en formato ISO 4217. El valor predeterminado siempre es USD.
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Requerido
Identificador único del objeto de orden al que está asociado este evento.
hash
Se puede pasar un hash en lugar del parámetro order. El órden se va agregar y despues rastreado. Mostrar atributos
string
Obligatorio si no se especifica session. Identificador único del objeto de perfil al que pertenece este evento. Si no se especifica explícitamente, el identificador de perfil se puede heredar cuando se especifica el parámetro session y la sesión ya está asociada a un perfil o se adjunta posteriormente a uno.
string
Obligatorio si no se especifica profile. Identificador del objeto de sesión al que pertenece este evento. Las sesiones son identificadores generados automáticamente a partir de los clics de los visitantes en enlaces cortos o de la librería Hellotext.js al realizar seguimientos de visitantes anónimos. Es una forma de rastrear eventos en el lado del cliente sin autenticar o revelar el identificador del perfil, lo que permite asociarlo más tarde a un perfil de forma segura en el lado del servidor. Más información sobre Sesiones.
epoch
Fecha original en que ocurrió el evento. Esto es útil si desea registrar un evento que sucedió en el pasado. Si no se proporciona ningún valor, su valor será el mismo de created_at.
url
url
El URL de la pagína este evento se occuro.
curl https://api.hellotext.com/v1/attribution/events \
  -d action="order.placed" \
  -d order=wx4Vn4no \
  -d session=2KAGgAgm \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "status": "received"
}

Eventos de productos

Seguimiento de los eventos de compras realizadas por tus clientes. Si tus clientes realizan órdenes, puedes realizar un seguimiento de las acciones de la orden. Las acciones de productos disponibles son product.purchased cuando un cliente compra un producto y product.viewed cuando un producto es visto.

Los valores monetarios asociados a la compra del producto se agregarán a los informes de la campaña.

Este punto final se puede utilizar con Productos y Variantes de productos. Si desea realizar un seguimiento de un Producto o Variante de producto existente, asegúrese de pasar el id, reference o sku de un registro existente. Si desea crear un nuevo Producto, debe pasar el parámetro product_parameters. De manera similar, si desea crear una nueva Variante de producto, asegúrese de pasar el product_variant_parameters en su lugar.

Parámetros
enum
Requerido
El nombre de la acción a rastrear.
Valores enum posibles
product.purchased
product.viewed
float
Monto monetario que representa los ingresos asociados a este evento. El valor predeterminado es null.
currency
Moneda para el cantidad proporcionada en formato ISO 4217. El valor predeterminado siempre es USD.
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Requerido
El id, reference o sku de un objeto de producto existente. Opcional cuando pasa product_parameters o product_variant. Requerido al pasar product_variant_parameters.
hash
Se puede pasar un hash en lugar del parámetro product. El producto se va agregar y despues rastreado. Mostrar atributos
string
Requerido
El id, reference o sku de un objeto de variante de producto existente. Opcional cuando especifica product_variant_parameters.
hash
Un hash que se puede pasar en lugar del parámetro product_variant. La variante de producto se creará y se realizará el seguimiento del evento. Al pasar este parámetro, asegúrese también de especificar el producto mediante el parámetro product. Mostrar atributos
string
Obligatorio si no se especifica session. Identificador único del objeto de perfil al que pertenece este evento. Si no se especifica explícitamente, el identificador de perfil se puede heredar cuando se especifica el parámetro session y la sesión ya está asociada a un perfil o se adjunta posteriormente a uno.
string
Obligatorio si no se especifica profile. Identificador del objeto de sesión al que pertenece este evento. Las sesiones son identificadores generados automáticamente a partir de los clics de los visitantes en enlaces cortos o de la librería Hellotext.js al realizar seguimientos de visitantes anónimos. Es una forma de rastrear eventos en el lado del cliente sin autenticar o revelar el identificador del perfil, lo que permite asociarlo más tarde a un perfil de forma segura en el lado del servidor. Más información sobre Sesiones.
epoch
Fecha original en que ocurrió el evento. Esto es útil si desea registrar un evento que sucedió en el pasado. Si no se proporciona ningún valor, su valor será el mismo de created_at.
url
url
El URL de la pagína este evento se occuro.
curl https://api.hellotext.com/v1/attribution/events \
  -d action="product.purchased" \
  -d product=vxqQJ3Yg \
  -d session=2KAGgAgm \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "status": "received"
}

Eventos de reembolsos

Realiza un seguimiento de los eventos relacionados con los reembolsos solicitados por tus clientes. Las acciones disponibles son refund.requested y refund.received.

Los valores monetarios asociados a los reembolsos emitidos se agregarán a los informes de la campaña.

Parámetros
enum
Requerido
El nombre de la acción a rastrear.
Valores enum posibles
refund.received
refund.requested
float
Monto monetario que representa los ingresos asociados a este evento. El valor predeterminado es null.
currency
Moneda para el cantidad proporcionada en formato ISO 4217. El valor predeterminado siempre es USD.
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Obligatorio si no se especifica session. Identificador único del objeto de perfil al que pertenece este evento. Si no se especifica explícitamente, el identificador de perfil se puede heredar cuando se especifica el parámetro session y la sesión ya está asociada a un perfil o se adjunta posteriormente a uno.
string
Requerido
Identificador único del objeto de reembolso al que está asociado este evento.
hash
Se puede pasar un hash en lugar del parámetro refund. El reembolsos se va agregar y despues rastreado. Mostrar atributos
string
Obligatorio si no se especifica profile. Identificador del objeto de sesión al que pertenece este evento. Las sesiones son identificadores generados automáticamente a partir de los clics de los visitantes en enlaces cortos o de la librería Hellotext.js al realizar seguimientos de visitantes anónimos. Es una forma de rastrear eventos en el lado del cliente sin autenticar o revelar el identificador del perfil, lo que permite asociarlo más tarde a un perfil de forma segura en el lado del servidor. Más información sobre Sesiones.
epoch
Fecha original en que ocurrió el evento. Esto es útil si desea registrar un evento que sucedió en el pasado. Si no se proporciona ningún valor, su valor será el mismo de created_at.
url
url
El URL de la pagína este evento se occuro.
curl https://api.hellotext.com/v1/attribution/events \
  -d action="refund.added" \
  -d refund=wx4Vn4no \
  -d product=vxqQJ3Yg \
  -d session=2KAGgAgm \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "status": "received"
}

Eventos personalizados

Hellotext te proporciona una lista de acciones pre-definidas para rastrear las interacciones más comunes de tus clientes como compras, visitas a tu sitio, productos agregados al carrito, formularios completados y más. Sin embargo, esto no siempre es suficiente y a veces necesitas mayor control y flexibilidad en definir acciones más específicas a las necesidades de tu negocio.

Es posible especificar cualquier nombre de acción personalizado al rastrear eventos siempre que el objeto de acción se haya creado previamente. Una vez creada la acción simplemente puedes utilizar su nombre para realizar un seguimiento.

Ten en cuenta que los valores monetarios transferidos a estos eventos se agregarán a los informes de la campaña como ventas.

Más sobre Acciones.

Parámetros
string
Requerido
El nombre de la acción personalizada para realizar un seguimiento. La acción personalizada debe crearse previamente.
float
Monto monetario que representa los ingresos asociados a este evento. El valor predeterminado es null.
app
string
Identificador único del objeto de aplicación al que está asociado este evento.
string
Identificador único del objeto de cupon al que está asociado este evento.
currency
Moneda para el cantidad proporcionada en formato ISO 4217. El valor predeterminado siempre es USD.
string
Identificador único del objeto de formulario al que está asociado este evento.
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Identificador único del objeto de orden al que está asociado este evento.
string
Identificador único del objeto de producto asociado a este evento.
string
Obligatorio si no se especifica session. Identificador único del objeto de perfil al que pertenece este evento. Si no se especifica explícitamente, el identificador de perfil se puede heredar cuando se especifica el parámetro session y la sesión ya está asociada a un perfil o se adjunta posteriormente a uno.
string
Identificador único del objeto de reembolso al que está asociado este evento.
string
Obligatorio si no se especifica profile. Identificador del objeto de sesión al que pertenece este evento. Las sesiones son identificadores generados automáticamente a partir de los clics de los visitantes en enlaces cortos o de la librería Hellotext.js al realizar seguimientos de visitantes anónimos. Es una forma de rastrear eventos en el lado del cliente sin autenticar o revelar el identificador del perfil, lo que permite asociarlo más tarde a un perfil de forma segura en el lado del servidor. Más información sobre Sesiones.
epoch
Fecha original en que ocurrió el evento. Esto es útil si desea registrar un evento que sucedió en el pasado. Si no se proporciona ningún valor, su valor será el mismo de created_at.
url
url
El URL de la pagína este evento se occuro.
curl https://api.hellotext.com/v1/attribution/events \
  -d action="signup_form.completed" \
  -d session=2KAGgAgm \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "status": "received"
}

Acciones

Hellotext proporciona un conjunto básico de acciones, perfecto para comenzar su próxima campaña de atribución. Pero, cuando surge la necesidad de rastrear diferentes acciones no proporcionadas por Hellotext, puede ampliar el conjunto de acciones disponibles creando sus propias acciones personalizadas.

Puede nombrar las acciones de la manera que desee. Recomendamos tomar un enfoque de puntos al nombrar sus acciones, para tenerlas agrupadas y con estados, por ejemplo, las acciones personalizadas pueden ser como las siguientes.

Ver Eventos personalizados para más información.

Ejemplos de acciones personalizadas
subscriber.signed_up
signup_form.completed
subscriber.voted
  • POST

    v1/attribution/actions

  • GET

    v1/attribution/actions/:id

  • PATCH

    v1/attribution/actions/:id

  • DELETE

    v1/attribution/actions/:id

  • GET

    v1/attribution/actions

El objeto de acción

Atributos
id
String
Identificador único del objeto.
Type
Tipo de objeto. Esto es siempre action.
Epoch
Fecha de creación del objeto.
Boolean
Este acción se utiliza como una métrica para KPIs?. El valor predeterminado es false. Si se establece en true, los eventos con este acción se pueden utilizar como una métrica para KPIs que se muestran en las Campañas y las Rutas.
String
El nombre de la acción. Este es el nombre que se usa en el parámetro action al momento de crear un evento. No se permiten nombres duplicados.
Boolean
¿Esta acción es pasiva o no? El valor predeterminado es true.

Los eventos pasivos son eventos que no afectan el orden de las conversaciones en la bandeja de entrada, cuando se graba un evento pasivo, la posición de la conversación no cambia. Los eventos pasivos no se muestran en la bandeja de entrada, solo se muestran en el registro de actividad de un perfil.

Los eventos no pasivos son eventos que afectan el orden de las conversaciones en la bandeja de entrada, cuando se registra un evento activo, la posición de la conversación se actualiza y se mueve a la parte superior para que pueda ser manejada. Los eventos no pasivos se registran en la Bandeja de entrada y en el Registro de actividad.

Generalmente, si la acción es importante (requiere una acción por parte de su equipo) y desea verla fácilmente en la bandeja de entrada cuando suceda, mantenga este atributo como false. Sin embargo, si la acción no es importante, puede marcarla como pasiva.
String
Nombre alternativo de la acción utilizada en Segmentos y Rutas. Si no se proporciona, será el mismo que el parámetro de nombre.
{
  "id": "Wvqz2qD1",
  "type": "action",
  "created_at": 1665684173,
  "goal": false,
  "name": "signup_form.completed",
  "passive": true,
  "title": "Signup-form completed"
}

Crear una acción

Crea una nueva acción.

Parámetros
Boolean
Este acción se utiliza como una métrica para KPIs?. El valor predeterminado es false. Si se establece en true, los eventos con este acción se pueden utilizar como una métrica para KPIs que se muestran en las Campañas y las Rutas.
String
Requerido
El nombre de la acción. Este es el nombre que se usa en el parámetro action al momento de crear un evento. No se permiten nombres duplicados.
Boolean
¿Esta acción es pasiva o no? El valor predeterminado es true.
String
Nombre alternativo de la acción utilizada en Segmentos y Rutas. Si no se proporciona, será el mismo que el parámetro de nombre.
curl -X POST https://api.hellotext.com/v1/attribution/actions 
 -d name="signup_form.completed" 
 -d title="Signup-form completed" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "Wvqz2qD1",
  "type": "action",
  "created_at": 1665684173,
  "goal": false,
  "name": "signup_form.completed",
  "passive": true,
  "title": "Signup-form completed"
}

Obtener una acción

Obtener una acción existente.

curl -G https://api.hellotext.com/v1/attribution/actions/Wvqz2qD1 \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Modificar una acción

Modificar la acción especificada con la información proporcionada.

Parámetros
Boolean
Este acción se utiliza como una métrica para KPIs?. El valor predeterminado es false. Si se establece en true, los eventos con este acción se pueden utilizar como una métrica para KPIs que se muestran en las Campañas y las Rutas.
String
Requerido
El nombre de la acción. Este es el nombre que se usa en el parámetro action al momento de crear un evento. No se permiten nombres duplicados.
Boolean
¿Esta acción es pasiva o no? El valor predeterminado es true.
String
Nombre alternativo de la acción utilizada en Segmentos y Rutas. Si no se proporciona, será el mismo que el parámetro de nombre.
curl -X PATCH https://api.hellotext.com/v1/attribution/actions/:id 
 -d name="contact.subscribed" 
 -d title="Contact Subscribed" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "Wvqz2qD1",
  "type": "action",
  "created_at": 1665684173,
  "goal": false,
  "name": "contact.subscribed",
  "passive": true,
  "title": "Contact Subscribed"
}

Eliminar una acción

Elimina permanentemente la acción especificada.

Esta acción es irreversible. Al eliminar una acción, también se eliminarán todos los eventos rastreados asociados a ella. Tenga cuidado al usar este endpoint.

curl -X DELETE https://api.hellotext.com/v1/attribution/actions/Wvqz2qD1 \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "Wvqz2qD1",
  "type": "action",
  "deleted": true
}

Listar todas las acciones

Enumera las acciones existentes ordenadas por las más recientes. Los parámetros de paginación están disponibles en listas.

Parámetros
String
Mostrar resultados listados antes (más recientes) que el id dado.
integer
Limitar cuántos resultados mostrar. El valor por defecto es 25. El máximo es 100.
String
Mostrar resultados listados después (más antiguos) que el id dado.
curl -G https://api.hellotext.com/v1/attribution/actions 
 -d limit=5 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "actions": [
    {
      "id": "Wvqz2qD1",
      "type": "action",
      "created_at": 1665684173,
      "goal": false,
      "name": "signup_form.completed",
      "passive": true,
      "title": "Signup-form completed"
    },
    "{...}",
    "{...}"
  ]
}

Apps

Los objetos de aplicación representan las aplicaciones propias o administradas con las que interactúa tu audiencia. Por ejemplo, estas podrían ser tus aplicaciones iOS o Android.

Puedes realizar un seguimiento de los eventos de tu audiencia que interactúan con tus aplicaciones. Por ejemplo, cuando alguien instala una aplicación, la elimina o gasta cualquier cantidad.

Conocer más Eventos de app.

  POST /v1/attribution/apps
   GET /v1/attribution/apps/:id
 PATCH /v1/attribution/apps/:id
DELETE /v1/attribution/apps/:id
   GET /v1/attribution/apps

El objeto de la aplicación

Atributos
id
string
Identificador único del evento de seguimiento.
string
Tipo de objeto. Siempre es aplicación.
epoch
Fecha de creación del objeto de la aplicación.
url
Una URL del icono de la aplicación en alta resolución. Descargaremos la imagen y la almacenaremos en nuestros servidores.
hash
Conjunto de pares key-value que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
El nombre de la aplicación. No se permiten nombres duplicados.
{
  "id": "xnqJQ47v",
  "type": "app",
  "created_at": 1665684173
  "image_url": "https://www.beautyandcare.com/apps/awesome.jpg",
  "metadata": {},
  "name": "Beauty & Care",
}

Crear una aplicación

Crea una nueva aplicación.

Parámetros
url
Una URL del icono de la aplicación en alta resolución. Descargaremos la imagen y la almacenaremos en nuestros servidores.
string
Requerido
El nombre de la aplicación. No se permiten nombres duplicados.
curl https://api.hellotext.com/v1/attribution/apps \
  -d name="Beauty & Care" \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "xnqJQ47v",
  "type": "app",
  "created_at": 1665684173
  "image_url": null,
  "metadata": {},
  "name": "Beauty & Care",
}

Obtener una aplicación

Obtener una aplicación existente.

curl -G https://api.hellotext.com/v1/attribution/apps/xnqJQ47v \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Modiciar una aplicación

Modificar la aplicación especificada con la información proporcionada.

Parámetros
url
Una URL del icono de la aplicación en alta resolución. Descargaremos la imagen y la almacenaremos en nuestros servidores. Proporcionar null se eliminará la imagen adjunta
string
El nombre de la aplicación. No se permiten nombres duplicados.
curl https://api.hellotext.com/v1/attribution/apps/xnqJQ47v \
  -d name="Beauty & More" \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "xnqJQ47v",
  "type": "app",
  "created_at": 1665684173
  "image_url": null,
  "metadata": {},
  "name": "Beauty & More",
}

Eliminar una aplicación

Elimina permanentemente la aplicación especificada.

curl -X DELETE https://api.hellotext.com/v1/attribution/apps/xnqJQ47v \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "xnqJQ47v",
  "type": "app",
  "deleted": true
}

Listar todas las aplicaciones

Enumera las aplicaciones existentes ordenadas por las más recientes. Los parámetros de paginación están disponibles en listas.

Parámetros
string
Muestra los resultados después (más antiguos) que el identificador proporcionado.
string
Muestra los resultados antes (más recientes) que el identificador proporcionado.
integer
Limite la cantidad de resultados que se mostrarán. El valor predeterminado es 25. El máximo es 100.
curl -G https://api.hellotext.com/v1/attribution/apps \
  -d limit=5 \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "apps": [
    {
      "id": "xnqJQ47v",
      "type": "app",
      "created_at": 1665684173
      "image_url": "https://www.beautyandcare.com/apps/awesome.jpg",
      "metadata": {},
      "name": "Beauty & Care",
    },
    {...},
    {...}
  ]
}

Carts

Los objetos de carrito representan objetos de carrito de compras que se pueden utilizar para determinar qué elementos tiene el perfil en el carrito en un momento determinado.

Los objetos de carrito actúan como grupos lógicos donde puedes agrupar varios productos agregados a un carrito juntos.

Puedes rastrear cuándo se agregan elementos al carrito, se eliminan del carrito o cuándo se abandonó el carrito.

Conocer más Eventos de carrito.

  • POST

    v1/attribution/carts

  • GET

    v1/attribution/carts/:id

  • PATCH

    v1/attribution/carts/:id

  • DELETE

    v1/attribution/carts/:id

  • GET

    v1/attribution/carts

El objeto de carrito

Atributos
id
String
Identificador único del objeto.
Type
Tipo de objeto. Esto es siempre cart.
Epoch
Fecha de creación del objeto.
array
Una colección de elementos incluidos en el carrito en el momento actual. Mostrar atributos
Hash
Conjunto de pares clave-valor que puedes adjuntar al carrito. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
profile
El identificador del perfil al que pertenece este carrito.
String
El número de carrito o identificador original de la fuente externa que creó el carrito.
String
El identificador de la sesión a la que pertenece este carrito.
String
La fuente o plataforma de donde se generó este carrito.
{
  "id": "wx4Vn4no",
  "type": "cart",
  "created_at": 1665684173,
  "items": [
    {
      "id": "wx4Vn4no",
      "type": "cart_item",
      "created_at": 1665684173,
      "price": {
        "amount": "100.00",
        "converted_amount": "100.00",
        "converted_currency": "EUR",
        "currency": "USD"
      },
      "product": "vxqQJ3Yg",
      "quantity": 1
    },
    "{...}",
    "{...}"
  ],
  "metadata": {
  },
  "profile": "MzYwlE50",
  "reference": "ABC123",
  "session": "Vdqlg4nL",
  "source": null
}

Crear un carrito

Crea un nuevo carrito.

Parámetros
array
Una colección de elementos de carrito que se incluyen en este carrito. Mostrar atributos
profile
El identificador único del perfil al que pertenece este carrito. Requerido si no se proporciona session.
String
El número de carrito o identificador original de la fuente externa que creó el carrito.
String
"El identificador único de la sesión a la que pertenece este carrito. Requerido si no se proporciona profile." "Se puede usar para asociar el carrito con un perfil indefinido. Y luego adjuntar el carrito al perfil una vez que se conozca el perfil."
String
La fuente o plataforma de donde se generó este carrito.
curl -X POST https://api.hellotext.com/v1/attribution/carts 
 -d metadata[attribute1]=value1 
 -d metadata[attribute2]=value2 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "wx4Vn4no",
  "type": "cart",
  "created_at": 1665684173,
  "items": [
    {
      "id": "wx4Vn4no",
      "type": "cart_item",
      "created_at": 1665684173,
      "price": {
        "amount": "100.00",
        "converted_amount": "100.00",
        "converted_currency": "EUR",
        "currency": "USD"
      },
      "product": "vxqQJ3Yg",
      "quantity": 1
    },
    "{...}",
    "{...}"
  ],
  "metadata": {
    "attribute1": "value1",
    "attribute2": "value2"
  },
  "profile": "MzYwlE50",
  "reference": "ABC123",
  "session": "Vdqlg4nL",
  "source": null
}

Obtener un carrito

Obtener un carrito existente.

curl -G https://api.hellotext.com/v1/attribution/carts/wx4Vn4no 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Modificar un carrito

Modificar el carrito especificado con la información proporcionada.

Parámetros
array
"Una colección de elementos de carrito que reemplazan los elementos actuales en el carrito." "Pasando un valor vacío de [] eliminará todos los elementos del carrito." "Ignorar el parámetro no cambiará los elementos actuales en el carrito." Mostrar atributos
array
Una colección de nuevos elementos de carrito para agregar al carrito. Considere usar la API de seguimiento de carritos para agregar elementos a un carrito existente, ya que también se mostrará en el Rastro de Actividad de un Perfil. Mostrar atributos
profile
El identificador único del perfil al que pertenece este carrito. Requerido si no se proporciona session.
String
El número de carrito o identificador original de la fuente externa que creó el carrito.
String
"El identificador único de la sesión a la que pertenece este carrito. Requerido si no se proporciona profile." "Se puede usar para asociar el carrito con un perfil indefinido. Y luego adjuntar el carrito al perfil una vez que se conozca el perfil."
String
La fuente o plataforma de donde se generó este carrito.
curl -X PATCH https://api.hellotext.com/v1/attribution/carts/wx4Vn4no 
 -d metadata[attribute1]=value1 
 -d metadata[attribute2]=value2 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "wx4Vn4no",
  "type": "cart",
  "created_at": 1665684173,
  "items": [
    {
      "id": "wx4Vn4no",
      "type": "cart_item",
      "created_at": 1665684173,
      "price": {
        "amount": "100.00",
        "converted_amount": "100.00",
        "converted_currency": "EUR",
        "currency": "USD"
      },
      "product": "vxqQJ3Yg",
      "quantity": 1
    },
    "{...}",
    "{...}"
  ],
  "metadata": {
    "attribute1": "value1",
    "attribute2": "value2"
  },
  "profile": "MzYwlE50",
  "reference": "ABC123",
  "session": "Vdqlg4nL",
  "source": null
}

Eliminar un carrito

Elimina permanentemente el carrito especificado.

curl -X DELETE https://api.hellotext.com/v1/attribution/carts/wx4Vn4no 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "wx4Vn4no",
  "type": "cart",
  "deleted": true
}

Listar todos los carros

Enumera los carritos existentes ordenados por los más recientes. Los parámetros de paginación están disponibles en listas.

Parámetros
String
Mostrar resultados listados antes (más recientes) que el id dado.
integer
Limitar cuántos resultados mostrar. El valor por defecto es 25. El máximo es 100.
String
Mostrar resultados listados después (más antiguos) que el id dado.
curl -G https://api.hellotext.com/v1/attribution/carts 
 -d limit=5 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "carts": [
    {
      "id": "wx4Vn4no",
      "type": "cart",
      "created_at": 1665684173,
      "items": [
        {
          "id": "wx4Vn4no",
          "type": "cart_item",
          "created_at": 1665684173,
          "price": {
            "amount": "100.00",
            "converted_amount": "100.00",
            "converted_currency": "EUR",
            "currency": "USD"
          },
          "product": "vxqQJ3Yg",
          "quantity": 1
        },
        "{...}",
        "{...}"
      ],
      "metadata": {
      },
      "profile": "MzYwlE50",
      "reference": "ABC123",
      "session": "Vdqlg4nL",
      "source": null
    },
    "{...}",
    "{...}"
  ]
}

Eventos

Los eventos representan las acciones individuales de tus clientes que deseas rastrear. Todos los eventos siempre se asocian a un perfil a través de un session o perfil.

Un evento siempre requiere una acción de la que deseas realizar un seguimiento. Consulta la sección Seguimiento para obtener más información sobre las diferentes formas de realizar un seguimiento de los eventos.

  POST /v1/attribution/events
   GET /v1/attribution/events/:id
 PATCH /v1/attribution/events/:id
DELETE /v1/attribution/events/:id
   GET /v1/attribution/events

El objeto de evento

Atributos
id
string
Identificador único del objeto de evento.
string
Tipo de objeto. Este es siempre event.
hash
Un hash que representa el objeto de acción. Mostrar atributos
float
Monto monetario que representa los ingresos asociados a este evento. El valor predeterminado es null.
string
Importe monetario que representa los ingresos asociados a esta orden convertida a la moneda de informe del negocio.
string
Moneda para el converted_amount proporcionada en formato ISO 4217.
epoch
Fecha de creación del objeto de evento.
currency
Moneda para el cantidad proporcionada en formato ISO 4217. El valor predeterminado siempre es USD.
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Obligatorio si no se especifica session. Identificador único del objeto de perfil al que pertenece este evento. Si no se especifica explícitamente, el identificador de perfil se puede heredar cuando se especifica el parámetro session y la sesión ya está asociada a un perfil o se adjunta posteriormente a uno.
string
Obligatorio si no se especifica profile. Identificador del objeto de sesión al que pertenece este evento. Las sesiones son identificadores generados automáticamente a partir de los clics de los visitantes en enlaces cortos o de la librería Hellotext.js al realizar seguimientos de visitantes anónimos. Es una forma de rastrear eventos en el lado del cliente sin autenticar o revelar el identificador del perfil, lo que permite asociarlo más tarde a un perfil de forma segura en el lado del servidor. Más información sobre Sesiones.
hash
Un hash que representa el objeto rastreado. Mostrar atributos
epoch
Fecha original en que ocurrió el evento. Esto es útil si desea registrar un evento que sucedió en el pasado. Si no se proporciona ningún valor, su valor será el mismo de created_at.
url
url
El URL de la pagína este evento se occuro.
{
  "id": "xnqJQ47v",
  "type": "event",
  "action": {
    "id": "Wvqz2qD1",
    "name": "order.confirmed",
    "title": "Product purchased"
  },
  "amount": 199.95,
  "converted_amount": "19.90",
  "converted_amount_currency": "EUR",
  "created_at": 1665684173,
  "currency": "USD",
  "metadata": {},
  "profile": "MzYwlE50",
  "session": "Vdqlg4nL",
  "trackable": {
    "id": "ro4a731w",
    "type": "order",
    "amount": 199.95,
    "currency": "USD",
    "product_ids": ["xnqJQ47v"]
  },
  "tracked_at": "1665684173",
}

Obtener un evento

Obtener un evento existente.

curl -G https://api.hellotext.com/v1/attribution/events/xnqJQ47v \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Modificar un evento

Modificar el evento especificado con la información proporcionada.

Parámetros
string
El nombre de la acción.
float
Monto monetario que representa los ingresos asociados a este evento. El valor predeterminado es null.
app
string
Identificador único del objeto de aplicación al que está asociado este evento.
currency
Moneda para el cantidad proporcionada en formato ISO 4217. El valor predeterminado siempre es USD.
string
Identificador único del objeto de formulario al que está asociado este evento.
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Identificador único del objeto de orden al que está asociado este evento.
string
Identificador único del objeto de producto asociado a este evento.
string
Una colección de identificadores de productos.
string
Obligatorio si no se especifica session. Identificador único del objeto de perfil al que pertenece este evento. Si no se especifica explícitamente, el identificador de perfil se puede heredar cuando se especifica el parámetro session y la sesión ya está asociada a un perfil o se adjunta posteriormente a uno.
string
Identificador único del objeto de reembolso al que está asociado este evento.
string
Obligatorio si no se especifica profile. Identificador del objeto de sesión al que pertenece este evento. Las sesiones son identificadores generados automáticamente a partir de los clics de los visitantes en enlaces cortos o de la librería Hellotext.js al realizar seguimientos de visitantes anónimos. Es una forma de rastrear eventos en el lado del cliente sin autenticar o revelar el identificador del perfil, lo que permite asociarlo más tarde a un perfil de forma segura en el lado del servidor. Más información sobre Sesiones.
epoch
Fecha original en que ocurrió el evento. Esto es útil si desea registrar un evento que sucedió en el pasado. Si no se proporciona ningún valor, su valor será el mismo de created_at.
url
url
El URL de la pagína este evento se occuro.
curl https://api.hellotext.com/v1/attribution/events/xnqJQ47v \
  -d amount=295.00 \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "xnqJQ47v",
  "type": "event",
  "action": {
    "id": "Wvqz2qD1",
    "name": "order.confirmed",
    "title": "Product purchased"
  },
  "amount": 295.00,
  "converted_amount": "19.90",
  "converted_amount_currency": "EUR",
  "created_at": 1665684173,
  "currency": "USD",
  "metadata": {},
  "profile_id": "MzYwlE50",
  "session_id": "Vdqlg4nL",
  "trackable": {
    "id": "ro4a731w",
    "type": "order",
    "amount": 199.95,
    "currency": "USD",
    "product_ids": ["xnqJQ47v"]
  },
  "tracked_at": "1665684173",
}

Eliminar un evento

Elimina permanentemente el evento especificado.

curl -X DELETE https://api.hellotext.com/v1/attribution/events/xnqJQ47v \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "xnqJQ47v",
  "type": "event",
  "deleted": true
}

Listar todos los eventos

Enumera los eventos existentes ordenados por los más recientes. Los parámetros de paginación están disponibles en listas.

Parámetros
string
Muestra los resultados después (más antiguos) que el identificador proporcionado.
string
Muestra los resultados antes (más recientes) que el identificador proporcionado.
integer
Limite la cantidad de resultados que se mostrarán. El valor predeterminado es 25. El máximo es 100.
curl -G https://api.hellotext.com/v1/attribution/events \
  -d limit=5 \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "events": [
    {
      "id": "xnqJQ47v",
      "type": "event",
      "action": {
        "id": "Wvqz2qD1",
        "name": "order.confirmed",
        "title": "Product purchased"
      },
      "amount": 199.95,
      "converted_amount": "19.90",
      "converted_amount_currency": "EUR",
      "created_at": 1665684173
      "currency": "USD",
      "metadata": {},
      "profile": "MzYwlE50",
      "session": "Vdqlg4nL",
      "trackable": {
        "id": "ro4a731w",
        "type": "order",
        "amount": 199.95,
        "currency": "USD",
        "product_ids": ["xnqJQ47v"]
      },
      "tracked_at": "1665684173"
    },
    {...},
    {...}
  ]
}

Formularios

Los objetos de formulario representan objetos de formulario que puede usar cuando realizas un seguimiento de acciones como form.completed.

Los objetos de formularios actúan como grupos lógicos donde puede agrupar varias acciones en el mismo objeto para obtener mejores informes.

  POST /v1/attribution/forms
   GET /v1/attribution/forms/:id
 PATCH /v1/attribution/forms/:id
DELETE /v1/attribution/forms/:id
   GET /v1/attribution/forms

El objeto de formulario

Atributos
id
string
Identificador único del objeto de formulario.
string
Tipo de objeto. Siempre es form.
epoch
Fecha de creación del objeto de formulario.
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Cualquier nombre dado al formulario como referencia. No se permiten nombres duplicados.
{
  "id": "O8lOzkwa",
  "type": "form",
  "created_at": 1665684173
  "metadata": {},
  "name": "Sign-Up Form",
}

Crear un formulario

Crea un nuevo formulario.

Parámetros
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Requerido
Cualquier nombre dado al formulario como referencia. No se permiten nombres duplicados.
curl https://api.hellotext.com/v1/attribution/forms \
  -d name="Sign-Up Form" \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "O8lOzkwa",
  "type": "form",
  "created_at": 1665684173
  "metadata": {}
  "name": "Sign-Up Form",
}

Obtener un formulario

Obtener un formulario existente.

curl -G https://api.hellotext.com/v1/attribution/forms/O8lOzkwa \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Modificar un formulario

Modificar el formulario especificado con la información proporcionada.

Parámetros
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Cualquier nombre dado al formulario como referencia. No se permiten nombres duplicados.
curl https://api.hellotext.com/v1/attribution/forms/O8lOzkwa \
  -d name="Completion Form" \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "O8lOzkwa",
  "type": "form",
  "created_at": 1665684173
  "metadata": {},
  "name": "Completion Form",
}

Eliminar un formulario

Elimina permanentemente el formulario especificado.

curl -X DELETE https://api.hellotext.com/v1/attribution/forms/O8lOzkwa \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "O8lOzkwa",
  "type": "form",
  "deleted": true
}

Listar todas las formas

Enumera los formularios existentes ordenados por los más recientes. Los parámetros de paginación están disponibles en listas.

Parámetros
string
Muestra los resultados después (más antiguos) que el identificador proporcionado.
string
Muestra los resultados antes (más recientes) que el identificador proporcionado.
integer
Limite la cantidad de resultados que se mostrarán. El valor predeterminado es 25. El máximo es 100.
curl -G https://api.hellotext.com/v1/attribution/forms \
  -d limit=5 \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "forms": [
    {
      "id": "O8lOzkwa",
      "type": "form",
      "created_at": 1665684173
      "metadata": {},
      "name": "Sign-Up Form",
    },
    {...},
    {...}
  ]
}

Órdenes

Los objetos de órdenes representan objetos de órdenes que puede usar para rastrear acciones a lo largo de su ciclo de vida, como order.placed, order.confirmed, order.cancelled y order.enviado.

Los objetos de orden actúan como grupos lógicos en los que puede agrupar varias acciones en el mismo objeto para obtener mejores informes.

  POST /v1/attribution/orders
   GET /v1/attribution/orders/:id
 PATCH /v1/attribution/orders/:id
DELETE /v1/attribution/orders/:id
   GET /v1/attribution/orders

El objeto de la orden

Atributos
id
string
Identificador único del objeto de orden.
string
Tipo de objeto. Siempre es order.
epoch
Fecha de creación del objeto de orden.
enum
Especifica cómo se debe entregar la orden al cliente. Se puede usar en Rutas para establecer diferentes condiciones basadas en este valor. Los valores posibles son collect cuando los clientes compran directamente en la tienda o recogen en la tienda y deliver cuando se envía el paquete a la dirección del cliente. Este atributo no está establecido de forma predeterminada.
Valores enum posibles
collect
deliver
hash
Una colección de productos incluidos en la orden. Mostrar atributos
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
El número de pedido o el identificador original de la fuente externa que creó el pedido.
string
El identificador de la plataforma donde se creó el pedido.
hash
Un hash que representa el total y el total convertido del pedido. Mostrar atributos
{
  "id": "ro4a731w",
  "type": "order",
  "created_at": 1665684173
  "delivery": "deliver",
  "items": [
    {
      "id": "vxqQJ3Yg",
      "type": "order_item",
      "quantity": 1,
      "price": {
        "amount": "395.00",
        "currency": "USD"
      }
    }
  ],
  "metadata": {},
  "reference": "1234",
  "source": null,
  "total": {
    "amount": "395.00",
    "converted_amount": "19.90",
    "converted_amount_currency": "EUR",
    "currency": "USD",
  }
}

Crear una orden

Crea una nueva orden.

Parámetros
enum
Especifica cómo se debe entregar la orden al cliente. Se puede usar en Rutas para establecer diferentes condiciones basadas en este valor. Los valores posibles son collect cuando los clientes compran directamente en la tienda o recogen en la tienda y deliver cuando se envía el paquete a la dirección del cliente. Este atributo no está establecido de forma predeterminada.
Valores enum posibles
collect
deliver
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
array
Una colección de productos incluidos en el pedido. Puede ser una combinación de identificadores de productos o variantes de productos (id, reference o sku) y product_parameters y product_variant_parameters.

Al pasar un hash de product_parameters o product_variant_parameters, el producto o la variante del producto se creará automáticamente si aún no existe.

Asegúrate de establecer la reference o sku para el producto o la variante del producto para evitar la creación de productos duplicados. También puedes especificar la cantidad del producto con el atributo quantity.
string
El número de pedido o el identificador original de la fuente externa que creó el pedido.
string
El identificador de la plataforma donde se creó el pedido.
hash
Un hash que representa el total y el total convertido del pedido. Mostrar atributos
curl https://api.hellotext.com/v1/attribution/orders \
  -d amount=395.00 \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "ro4a731w",
  "type": "order",
  "created_at": 1665684173
  "delivery": "deliver",
  "items": [
    {
      "id": "vxqQJ3Yg",
      "type": "order_item",
      "quantity": 1,
      "price": {
        "amount": "395.00",
        "currency": "USD"
      }
    }
  ],
  "metadata": {},
  "reference": "1234",
  "source": null,
  "total": {
    "amount": "395.00",
    "converted_amount": "19.90",
    "converted_amount_currency": "EUR",
    "currency": "USD",
  }
}

Obtener una orden

Obtener una orden existente.

curl -G https://api.hellotext.com/v1/attribution/orders/ro4a731w \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Modificar una orden

Modificar la orden especificado con la información proporcionada.

Parámetros
enum
Especifica cómo se debe entregar la orden al cliente. Se puede usar en Rutas para establecer diferentes condiciones basadas en este valor. Los valores posibles son collect cuando los clientes compran directamente en la tienda o recogen en la tienda y deliver cuando se envía el paquete a la dirección del cliente. Este atributo no está establecido de forma predeterminada.
Valores enum posibles
collect
deliver
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
El número de pedido o el identificador original de la fuente externa que creó el pedido.
string
El identificador de la plataforma donde se creó el pedido.
hash
Un hash que representa el total y el total convertido del pedido.
curl https://api.hellotext.com/v1/attribution/orders/ro4a731w \
  -d metadata[state]="paid" \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "ro4a731w",
  "type": "order",
  "created_at": 1665684173
  "delivery": "deliver",
  "items": [
    {
      "id": "vxqQJ3Yg",
      "type": "order_item",
      "quantity": 1,
      "price": {
        "amount": "395.00",
        "currency": "USD"
      }
    }
  ],
  "metadata": {},
  "reference": "1234",
  "source": null,
  "total": {
    "amount": "395.00",
    "converted_amount": "19.90",
    "converted_amount_currency": "EUR",
    "currency": "USD",
  }
}

Eliminar una orden

Elimina permanentemente la orden especificada.

curl -X DELETE https://api.hellotext.com/v1/attribution/orders/ro4a731w \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "ro4a731w",
  "type": "order",
  "deleted": true
}

Listar todas las órdenes

Enumera las órdenes existentes ordenados por los más recientes. Los parámetros de paginación están disponibles en listas.

Parámetros
string
Muestra los resultados después (más antiguos) que el identificador proporcionado.
string
Muestra los resultados antes (más recientes) que el identificador proporcionado.
integer
Limite la cantidad de resultados que se mostrarán. El valor predeterminado es 25. El máximo es 100.
curl -G https://api.hellotext.com/v1/attribution/orders \
  -d limit=5 \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "orders": [
    {
      "id": "ro4a731w",
      "type": "order",
      "created_at": 1665684173
      "delivery": "deliver",
      "items": [
        {
          "id": "vxqQJ3Yg",
          "type": "order_item",
          "quantity": 1,
          "price": {
            "amount": "395.00",
            "currency": "USD"
          }
        }
      ],
      "metadata": {},
      "reference": "1234",
      "source": null,
      "total": {
        "amount": "395.00",
        "converted_amount": "19.90",
        "converted_amount_currency": "EUR",
        "currency": "USD",
      }
    },
    {...},
    {...}
  ]
}

Productos

Los objetos de producto representan productos que puedes usar para rastrear acciones a través de su ciclo de vida, como producto.comprado y producto.visto o carrito.agregado y carrito.eliminado.

Los objetos de producto actúan como grupos lógicos donde puedes agrupar múltiples acciones al mismo objeto para una mejor presentación de informes.

  • POST

    v1/attribution/products

  • GET

    v1/attribution/products/:id

  • PATCH

    v1/attribution/products/:id

  • DELETE

    v1/attribution/products/:id

  • GET

    v1/attribution/products

The Product Object

Atributos
id
String
Identificador único del objeto.
Type
Tipo de objeto. Esto es siempre product.
String
Nombre de la marca del producto.
array
Una colección de categorías representadas como una colección de valores de texto.
array
Nombre de colección para productos que pertenecen a una colección.
Epoch
Fecha de creación del objeto producto.
URL
Una URL del product en alta resolución.
Hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
String
Cualquier nombre asignado al producto como referencia. Este también es el nombre de la variante predeterminada.
hash
Un hash que representa la moneda del producto y el identificador asociado. También contiene el converted_amount y converted_identifier. Mostrar atributos
String
El número de producto o el identificador original de la fuente externa que creó el producto.
sku
String
Un identificador que distingue entre mayúsculas y minúsculas para la variante predeterminada del producto. Para un seguimiento y reporte de ventas efectivos, los SKUs deben ser únicos y ninguna variante de producto debe incluir el mismo SKU en sus detalles.
String
La fuente o plataforma de donde se generó este producto. Corresponde a la primera variante.
array
Una colección de etiquetas representadas como una matriz de cadenas.
array
Una array de todas las variantes del producto actual. Cada matriz contiene los aspectos únicos de la variante en comparación con el padre. Cada variante contiene un atributo id que puede utilizar para eliminar o actualizar esa variante específica. Mostrar atributos
{
  "id": "vxqQJ3Yg",
  "type": "product",
  "brand": "Adidas",
  "categories": [
    "shoes"
  ],
  "collection": [
    "350 v2"
  ],
  "created_at": 1665684173,
  "metadata": {
  },
  "name": "Yeezy Boost 350 v2",
  "price": {
    "amount": 220.0,
    "converted_amount": 220.0,
    "converted_currency": "EUR",
    "currency": "USD"
  },
  "reference": null,
  "sku": "1234567890",
  "source": null,
  "tags": [
    "Sneakers"
  ],
  "variants": [
    {
      "id": "vxqQJ3Yg",
      "type": "product_variant",
      "created_at": 1665684173,
      "image_url": "https://www.primesneakers.com/products/yeezy-350-v2.jpg",
      "metadata": {
      },
      "name": "Yeezy Boost 350 v2",
      "price": {
        "amount": 220.0,
        "converted_amount": 220.0,
        "converted_currency": "EUR",
        "currency": "USD"
      },
      "product": "vxqQJ3YQ",
      "reference": null,
      "sku": "1234567890",
      "source": null
    },
    "{...}",
    "{...}"
  ]
}

Crear un producto

Crea un nuevo producto.

Parámetros
String
Nombre de la marca del producto.
array
Una colección de categorías representadas como una colección de valores de texto.
array
Nombre de colección para productos que pertenecen a una colección.
URL
Una URL que apunta a una imagen del producto. Descargaremos la imagen y la almacenaremos en nuestros servidores. Asegúrate de que la URL sea de acceso público porque no podremos acceder a ella si requiere autenticación.
Hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
String
Requerido
Cualquier nombre asignado al producto como referencia. Este también es el nombre de la variante predeterminada.
hash
Un hash que representa la moneda del producto y el identificador asociado. También contiene el converted_amount y converted_identifier. Mostrar atributos
String
El número de producto o el identificador original de la fuente externa que creó el producto.
sku
String
Un identificador que distingue entre mayúsculas y minúsculas para la variante predeterminada del producto. Para un seguimiento y reporte de ventas efectivos, los SKUs deben ser únicos y ninguna variante de producto debe incluir el mismo SKU en sus detalles.
String
La fuente o plataforma de donde se generó este producto. Corresponde a la primera variante.
array
Una colección de etiquetas representadas como una matriz de cadenas.
array
Un array de hashes clave-valor que representan las variantes. Se crea una variante para cada elemento en el array. Mostrar atributos
curl -X POST https://api.hellotext.com/v1/attribution/products 
 -d name="Sign-Up Form" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "vxqQJ3Yg",
  "type": "product",
  "brand": "Adidas",
  "categories": [
    "shoes"
  ],
  "collection": [
    "350 v2"
  ],
  "created_at": 1665684173,
  "metadata": {
  },
  "name": "Sign-Up Form",
  "price": {
    "amount": 220.0,
    "converted_amount": 220.0,
    "converted_currency": "EUR",
    "currency": "USD"
  },
  "reference": null,
  "sku": "1234567890",
  "source": null,
  "tags": [
    "Sneakers"
  ],
  "variants": [
    {
      "id": "vxqQJ3Yg",
      "type": "product_variant",
      "created_at": 1665684173,
      "image_url": "https://www.primesneakers.com/products/yeezy-350-v2.jpg",
      "metadata": {
      },
      "name": "Yeezy Boost 350 v2",
      "price": {
        "amount": 220.0,
        "converted_amount": 220.0,
        "converted_currency": "EUR",
        "currency": "USD"
      },
      "product": "vxqQJ3YQ",
      "reference": null,
      "sku": "1234567890",
      "source": null
    },
    "{...}",
    "{...}"
  ]
}

Obtener un producto

Obtener un producto existente. Puedes usar el parámetro id, reference o sku para recuperar un producto.

curl -G https://api.hellotext.com/v1/attribution/products/vxqQJ3Yg 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Modificar un producto

Modificar el producto especificado con la información proporcionada. Puedes usar el parámetro id, reference o sku para actualizar un producto.

Parámetros
String
Nombre de la marca del producto.
array
Una colección de categorías representadas como una colección de valores de texto.
array
Nombre de colección para productos que pertenecen a una colección.
URL
Una URL que apunta a una imagen del producto. Descargaremos la imagen y la almacenaremos en nuestros servidores. Asegúrate de que la URL sea de acceso público porque no podremos acceder a ella si requiere autenticación.
Hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
String
Cualquier nombre asignado al producto como referencia. Este también es el nombre de la variante predeterminada.
array
Un array de nuevas variantes para agregar al producto. Cada variante es un hash de pares clave-valor. Mostrar atributos
hash
Un hash que representa la moneda del producto y el identificador asociado. También contiene el converted_amount y converted_identifier. Mostrar atributos
String
El número de producto o el identificador original de la fuente externa que creó el producto.
sku
String
Un identificador que distingue entre mayúsculas y minúsculas para la variante predeterminada del producto. Para un seguimiento y reporte de ventas efectivos, los SKUs deben ser únicos y ninguna variante de producto debe incluir el mismo SKU en sus detalles.
array
Una colección de etiquetas representadas como una matriz de cadenas.
array
Pasar un array vacío [] eliminará todas las variantes existentes del producto. Asegúrate de usar new_variants para agregar nuevas variantes al producto. Mostrar atributos
curl -X PATCH https://api.hellotext.com/v1/attribution/products/:id 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "vxqQJ3Yg",
  "type": "product",
  "brand": "Adidas",
  "categories": [
    "shoes"
  ],
  "collection": [
    "350 v2"
  ],
  "created_at": 1665684173,
  "metadata": {
  },
  "name": "Yeezy Boost 350 v2",
  "price": {
    "amount": 220.0,
    "converted_amount": 220.0,
    "converted_currency": "EUR",
    "currency": "USD"
  },
  "reference": null,
  "sku": "1234567890",
  "source": null,
  "tags": [
    "Sneakers"
  ],
  "variants": [
    {
      "id": "vxqQJ3Yg",
      "type": "product_variant",
      "created_at": 1665684173,
      "image_url": "https://www.primesneakers.com/products/yeezy-350-v2.jpg",
      "metadata": {
      },
      "name": "Yeezy Boost 350 v2",
      "price": {
        "amount": 220.0,
        "converted_amount": 220.0,
        "converted_currency": "EUR",
        "currency": "USD"
      },
      "product": "vxqQJ3YQ",
      "reference": null,
      "sku": "1234567890",
      "source": null
    },
    "{...}",
    "{...}"
  ]
}

Eliminar un producto

Elimina permanentemente el producto especificado. Puedes usar el parámetro id, reference o sku para eliminar un producto.

curl -X DELETE https://api.hellotext.com/v1/attribution/products/vxqQJ3Yg 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "vxqQJ3Yg",
  "type": "product",
  "deleted": true
}

Listar todos los productos

Enumera los productos existentes ordenados por los más recientes. Los parámetros de paginación están disponibles en listas.

Parámetros
String
Mostrar resultados listados antes (más recientes) que el id dado.
integer
Limitar cuántos resultados mostrar. El valor por defecto es 25. El máximo es 100.
String
Mostrar resultados listados después (más antiguos) que el id dado.
curl -G https://api.hellotext.com/v1/attribution/products 
 -d limit=5 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "products": [
    {
      "id": "vxqQJ3Yg",
      "type": "product",
      "brand": "Adidas",
      "categories": [
        "shoes"
      ],
      "collection": [
        "350 v2"
      ],
      "created_at": 1665684173,
      "metadata": {
      },
      "name": "Yeezy Boost 350 v2",
      "price": {
        "amount": 220.0,
        "converted_amount": 220.0,
        "converted_currency": "EUR",
        "currency": "USD"
      },
      "reference": null,
      "sku": "1234567890",
      "source": null,
      "tags": [
        "Sneakers"
      ],
      "variants": [
        {
          "id": "vxqQJ3Yg",
          "type": "product_variant",
          "created_at": 1665684173,
          "image_url": "https://www.primesneakers.com/products/yeezy-350-v2.jpg",
          "metadata": {
          },
          "name": "Yeezy Boost 350 v2",
          "price": {
            "amount": 220.0,
            "converted_amount": 220.0,
            "converted_currency": "EUR",
            "currency": "USD"
          },
          "product": "vxqQJ3YQ",
          "reference": null,
          "sku": "1234567890",
          "source": null
        },
        "{...}",
        "{...}"
      ]
    },
    "{...}",
    "{...}"
  ]
}

Variantes de Producto

El objeto Variante de Producto representa una variación específica de un producto. Por ejemplo, un producto con un tamaño y color puede tener múltiples variantes. Cada variante puede tener un precio, SKU o referencia diferente.

Las variantes pueden crearse directamente al crear un Producto a través del parámetro variants. O al actualizar un producto pasando el parámetro new_variants.

  • GET

    v1/attribution/variants/:id

  • PATCH

    v1/attribution/variants/:id

  • DELETE

    v1/attribution/variants/:id

  • POST

    v1/attribution/products/:product/variants

El objeto Variante de Producto

Atributos
id
String
Unique identifier of the product variant object.
Type
Type of object. This is always product_variant.
Epoch
Date of creation of the product variant object.
URL
URL of the image associated to the product variant.
Hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
String
Cualquier nombre dado a la variante como referencia.
hash
Un hash que representa la moneda del producto y el identificador asociado. También contiene el converted_amount y converted_identifier. Mostrar atributos
product
Identificador del objeto de producto asociado a esta variante.
String
El número de variante o el identificador original de la fuente externa que creó la variante.
sku
String
Un identificador que distingue entre mayúsculas y minúsculas para la variante del producto. Para un seguimiento y reporte de ventas efectivos, los SKUs deben ser únicos y ninguna variante de producto debe incluir el mismo SKU en sus detalles.
String
La fuente o plataforma de donde se generó esta variante de producto. Esto siempre es el mismo que el producto principal.
{
  "id": "vxqQJ3Yg",
  "type": "product_variant",
  "created_at": 1665684173,
  "image_url": "https://www.primesneakers.com/products/yeezy-350-v2.jpg",
  "metadata": {
  },
  "name": "Yeezy Boost 350 v2",
  "price": {
    "amount": 220.0,
    "converted_amount": 220.0,
    "converted_currency": "EUR",
    "currency": "USD"
  },
  "product": "vxqQJ3YQ",
  "reference": null,
  "sku": "1234567890",
  "source": null
}

Recuperar una Variante de Producto

Recupera los detalles de una Variante de Producto existente. Puedes obtener una Variante de Producto por su id, reference o sku.

curl -G https://api.hellotext.com/v1/attribution/variants/vxqQJ3Yg 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Actualizar una Variante de Producto

Actualiza la Variante de Producto especificada. Puedes actualizar una Variante de Producto por su id, reference o sku.

Atributos
URL
Una URL que apunta a una imagen de la variante. Descargaremos la imagen y la almacenaremos en nuestros servidores. Asegúrese de que la URL sea de acceso público porque no podremos acceder a ella si requiere autenticación.
Hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
String
Requerido
Cualquier nombre dado a la variante como referencia.
hash
Un hash que representa la moneda del producto y el identificador asociado. También contiene el converted_amount y converted_identifier. Mostrar atributos
String
El número de variante o el identificador original de la fuente externa que creó la variante.
sku
String
Un identificador que distingue entre mayúsculas y minúsculas para la variante del producto. Para un seguimiento y reporte de ventas efectivos, los SKUs deben ser únicos y ninguna variante de producto debe incluir el mismo SKU en sus detalles.
String
La fuente o plataforma de donde se generó esta variante de producto. Esto siempre es el mismo que el producto principal.
curl -X PATCH https://api.hellotext.com/v1/attribution/variants/vxqQJ3Yg 
 -d name="Yeezy boost 350 v2" 
 -d sku="5678" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "vxqQJ3YQ",
  "type": "product_variant",
  "created_at": 1665684173,
  "image_url": "https://www.primesneakers.com/products/yeezy-350-v2.jpg",
  "metadata": {
  },
  "name": "Yeezy boost 350 v2",
  "price": {
    "amount": 220.0,
    "converted_amount": 220.0,
    "converted_currency": "EUR",
    "currency": "USD"
  },
  "product": "vxqQJ3YQ",
  "reference": null,
  "sku": "5678",
  "source": null
}

Eliminar una Variante de Producto

Elimina la Variante de Producto especificada. Puedes eliminar una Variante de Producto por su id, reference o sku.

curl -X DELETE https://api.hellotext.com/v1/attribution/variants/vxqQJ3Yg 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "vxqQJ3Yg",
  "type": "product_variant",
  "deleted": true
}

Crear una Variante de Producto

Crea una nueva Variante de Producto.

Asegúrate de reemplazar :product con el id, reference o sku del Producto padre. Intentamos encontrar el producto padre primero por el id, luego por la referencia y finalmente por el sku. Cuando no se encuentra ningún producto padre, se devolverá un error 404.

Atributos
URL
Una URL que apunta a una imagen de la variante. Descargaremos la imagen y la almacenaremos en nuestros servidores. Asegúrese de que la URL sea de acceso público porque no podremos acceder a ella si requiere autenticación.
Hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
String
Requerido
Cualquier nombre dado a la variante como referencia.
hash
Un hash que representa la moneda del producto y el identificador asociado. También contiene el converted_amount y converted_identifier. Mostrar atributos
String
El número de variante o el identificador original de la fuente externa que creó la variante.
sku
String
Un identificador que distingue entre mayúsculas y minúsculas para la variante del producto. Para un seguimiento y reporte de ventas efectivos, los SKUs deben ser únicos y ninguna variante de producto debe incluir el mismo SKU en sus detalles.
String
La fuente o plataforma de donde se generó esta variante de producto. Esto siempre es el mismo que el producto principal.
curl -X POST https://api.hellotext.com/v1/attribution/products/vxqQJ3YQ/variants 
 -d name="Yeezy boost 350 v2" 
 -d sku="1234567890" 
 -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "vxqQJ3Yg",
  "type": "product_variant",
  "created_at": 1665684173,
  "image_url": "https://www.primesneakers.com/products/yeezy-350-v2.jpg",
  "metadata": {
  },
  "name": "Yeezy boost 350 v2",
  "price": {
    "amount": 220.0,
    "converted_amount": 220.0,
    "converted_currency": "EUR",
    "currency": "USD"
  },
  "product": "vxqQJ3YQ",
  "reference": null,
  "sku": "1234567890",
  "source": null
}

Reembolsos

Los objetos de reembolso representan reembolsos que puede utilizar para realizar un seguimiento de las acciones a lo largo de su ciclo de vida, como refund.requested y refund.received.

Los objetos de reembolso actúan como grupos lógicos en los que puede agrupar varias acciones en el mismo objeto para obtener mejores informes.

  POST /v1/attribution/refunds
   GET /v1/attribution/refunds/:id
 PATCH /v1/attribution/refunds/:id
DELETE /v1/attribution/refunds/:id
   GET /v1/attribution/refunds

El objeto del reembolso

Atributos
id
string
Identificador único del objeto de reembolso.
string
Tipo de objeto. Esto siempre es refund.
epoch
Fecha de creación del objeto de devolución.
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Identificador del objeto de perfil asociado al que pertenece este reembolso.
string
El número de reembolsado o el identificador original de la fuente externa que creó el reembolsado.
hash
El objeto reembolsado. Hash que representa el order o product asociado al reembolso. Este atributo es opcional y por defecto su valor es null.
string
El identificador de la plataforma desde la que se creó el reembolso.
hash
Un hash que representa el total y el total convertido del reembolso. Mostrar atributos
{
  "id": "w83Pj4PY",
  "type": "refund",
  "created_at": 1665684173
  "metadata": {},
  "profile": null,
  "reference": null,
  "refundable": {
    "id": "ro4a731w",
    "type": "order",
    "amount": "199.95",
    "created_at": 1665684173,
    "currency": "USD",
    "metadata": {}
  },
  "source": null,
  "total": {
    "amount": "199.95",
    "converted_amount": "199.95",
    "converted_currency": "EUR",
    "currency": "USD",
  }
}

Crear un reembolso

Crea un nuevo reembolso.

Parámetros
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Identificador del objeto de orden asociado a este reembolso. La orden se establecerá como el objeto refundable.
string
Identificador del objeto de producto asociado a este reembolso. El producto se establecerá como el objeto refundable.
string
Identificador del objeto de perfil asociado al que pertenece este reembolso.
string
El número de reembolsado o el identificador original de la fuente externa que creó el reembolsado.
string
El identificador de la plataforma desde la que se creó el reembolso.
hash
Un hash que representa el total y el total convertido del reembolso. Cuando no se especifica, el total se establecerá a partir del total del objeto order, o del price del objeto product. Mostrar atributos
curl https://api.hellotext.com/v1/attribution/refunds \
  -d amount=19.90 \
  -d order=ro4a731w \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "w83Pj4PY",
  "type": "refund",
  "created_at": 1665684173
  "metadata": {},
  "profile": null,
  "reference": null,
  "refundable": {
    "id": "ro4a731w",
    "type": "order",
    "amount": "199.95",
    "created_at": 1665684173,
    "currency": "USD",
    "metadata": {}
  },
  "source": null,
  "total": {
    "amount": "199.95",
    "converted_amount": "199.95",
    "converted_currency": "EUR",
    "currency": "USD",
  }
}

Obtener un reembolso

Obtener un reembolso existente.

curl -G https://api.hellotext.com/v1/attribution/refunds/w83Pj4PY \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."

Modificar un reembolso

Modificar el reembolso especificado con la información proporcionada.

Parámetros
hash
Conjunto de pares atributo-valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado.
string
Identificador del objeto de orden asociado a este reembolso. La orden se establecerá como el objeto refundable.
string
Identificador del objeto de producto asociado a este reembolso. El producto se establecerá como el objeto refundable.
string
Identificador del objeto de perfil asociado al que pertenece este reembolso.
string
El número de reembolsado o el identificador original de la fuente externa que creó el reembolsado.
string
El identificador de la plataforma desde la que se creó el reembolso.
hash
Un hash que representa el total y el total convertido del reembolso. Cuando no se especifica, el total se establecerá a partir del total del objeto order, o del price del objeto product.
curl https://api.hellotext.com/v1/attribution/refunds/w83Pj4PY \
  -d amount=24.90 \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "w83Pj4PY",
  "type": "refund",
  "created_at": 1665684173
  "metadata": {},
  "profile": null,
  "reference": null,
  "refundable": {
    "id": "ro4a731w",
    "type": "order",
    "amount": "199.95",
    "created_at": 1665684173,
    "currency": "USD",
    "metadata": {}
  },
  "source": null,
  "total": {
    "amount": "199.95",
    "converted_amount": "199.95",
    "converted_currency": "EUR",
    "currency": "USD",
  }
}

Eliminar un reembolso

Elimina permanentemente el reembolso especificado.

curl -X DELETE https://api.hellotext.com/v1/attribution/refunds/w83Pj4PY \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "id": "w83Pj4PY",
  "type": "refund",
  "deleted": true
}

Listar todos los reembolsos

Enumera los reembolsos existentes ordenados por los más recientes. Los parámetros de paginación están disponibles en listas.

Parámetros
string
Muestra los resultados después (más antiguos) que el identificador proporcionado.
string
Muestra los resultados antes (más recientes) que el identificador proporcionado.
integer
Limite la cantidad de resultados que se mostrarán. El valor predeterminado es 25. El máximo es 100.
curl -G https://api.hellotext.com/v1/attribution/refunds \
  -d limit=5 \
  -H "Authorization: Bearer ALK_eSMRuwJ2Al..."
{
  "refunds": [
    {
      "id": "w83Pj4PY",
      "type": "refund",
      "created_at": 1665684173
      "metadata": {},
      "profile": null,
      "reference": null,
      "refundable": {
        "id": "ro4a731w",
        "type": "order",
        "amount": "199.95",
        "created_at": 1665684173,
        "currency": "USD",
        "metadata": {}
      },
      "source": null,
      "total": {
        "amount": "199.95",
        "converted_amount": "199.95",
        "converted_currency": "EUR",
        "currency": "USD",
      }
    },
    {...},
    {...}
  ]
}

Sesiones

Las sesiones son identificadores únicos que se generan cuando los visitantes hacen clic en enlaces cortos y se adjuntan a la URL de destino como un parámetro GET llamado hello_session. Puedes pensar en una sesión compartiendo el mismo significado ya familiar de los navegadores web: representa un navegador de un visitante activo y es específico a un dispositivo.

Al realizar seguimientos de eventos con el identificador de sesión, estos mantendrán una asociación automática con el perfil del cliente que hizo clic en el enlace corto, agregando los eventos a su historial de actividades y al informe de la campaña o ruta donde estuvo presente el mensaje con el enlace corto.

Al realizar un seguimiento de los eventos del lado del cliente con la biblioteca Hellotext.js, no es necesario especificar explícitamente el identificador de la sesión, ya que la biblioteca se encargará de ello de manera automática.

Para mejorar la seguridad y la privacidad, desaconsejamos revelar el identificador del perfil directamente en el navegador. Debido a esto, la biblioteca Hellotext.js solo acepta realizar un seguimiento de los eventos que especifican un session y no un perfil directamente.

También es posible rastrear eventos para visitantes no identificados. La biblioteca Hellotext.js crea un nuevo identificador de sesión para cada nuevo visitante cuando no lo encuentra definido como parámetro. Puedes almacenar este identificador de sesión y luego adjuntar el perfil cuando se conozca, por ejemplo, cuando el visitante inicia sesión en la tienda, realiza una orden o se suscribe ingresando su número de teléfono.

  PATCH /v1/sessions/:id

Attach session

Una vez conocido el perfil, adjúntalo a la sesión para que todos sus eventos rastreados pasen a formar parte de su historial de actividades.

Si también deseas cambiar la sesión a un perfil diferente, configura el nuevo identificador de perfil en el parámetro profile y la sesión se asignará al nuevo perfil.

Todos los carritos asociados con una sesión se asignarán al perfil al que adjunta la sesión.

Parámetros
string
Requerido
El perfil para asignar la sesión y sus eventos rastreados.
hellotext
  • Mantente al día en eCommerce Marketing
  • Suscríbete para recibir info y actualizaciones de Hellotext
© 2024 Hellotext
  • Perú
  • Español