Lista de segmentación


La segmentación es un filtro que selecciona clientes potenciales de su base que tienen información específica, creando una lista dinámica. Con esto, es posible crear y realizar acciones de Marketing dirigidas, de acuerdo a sus necesidades dentro de RD Station Marketing.

Con esta nueva función de segmentación de API, podrá enumerar todos los objetivos existentes en su cuenta de RD Station Marketing y navegar a la lista de todos los clientes potenciales existentes en el segmentación seleccionado.

Métodos disponibles

Returns a list of segmentations.
Response Body
Field Type Description
id Integer The unique identifier of the segmentation.
name String Name of the Segmentation.
standard Boolean Lets you know if the segmentation is standard for the platform as soon as you create an account on RDSM.
created_at DateTime Segmentation creation date.
updated_at DateTime Date of last update of the segmentation.
process_status String Process status of the Segmentation.
links ArrayObjects The hyperlink list.

Example:

Code: 200

{
  "segmentations": [
    {
      "id": 1,
      "name": "All contacts in the Leads base",
      "standard": true,
      "created_at": "2021-09-24T14:14:04.510-03:00",
      "updated_at": "2021-09-24T14:14:04.510-03:00",
      "process_status": "processed",
      "links": [
        {
          "rel": "SELF",
          "href": "https://api.rd.services/platform/segmentations/1/contacts",
          "media": "application/json",
          "type": "GET"
        }
      ]
    }
  ]
}
Returns a list of Leads associated to the given segmentation.
Response Body
Field Type Description
uuid String The unique uuid associated to each RD Station Contact.
name String Name of the Lead.
email String Email of the Lead.
last_conversion_date DateTime Last conversion date of the Lead.
created_at DateTime Lead creation date.
links ArrayObjects The hyperlink list.

Example:

Code: 200

{
  "contacts": [
    {
      "uuid": "5408c5a3-4711-4f2e-8d0b-13407a3e30f3",
      "name": "Lead Example 11",
      "email": "leadexample11@example.org",
      "last_conversion_date": "2021-09-13T15:01:06.325-03:00",
      "created_at": "2021-09-13T15:01:06.325-03:00",
      "links": [
        {
          "rel": "SELF",
          "href": "https://api.rd.services/platform/contacts/5408c5a3-4711-4f2e-8d0b-13407a3e30f3",
          "media": "application/json",
          "type": "GET"
        }
      ]
    }
  ]
}

More info

Paginación
  • La api debe aceptar los parámetros page y page_size en path_params (?page=1&page_size=25)
  • El valor predeterminado del parámetro de page debe ser 1 y page_size debe ser 25
  • El tamaño máximo del parámetro page_size definido es 125 y si se excede se devuelve un error
  • Se deben devolver los headers pagination-total-rows, pagination-page-size y pagination-page
Ordenación
  • La api debe aceptar el parámetro de pedido (?order=name:desc)
  • El pedido acepta asc o desc, si no se informa el valor por defecto es asc
  • Los campos aceptados para ordenar las segmentaciones son: process_status, created_at and updated_at
Segmentaciones estándar
  • Estas son todas aquellas segmentaciones que se configuraron previamente en RD Station Marketing
  • Las segmentaciones "Todos los contactos de la base de Leads", "Clientes (etapa en el embudo)" y "Leads (etapa en el embudo)" son ejemplos de segmentaciones estándar.
  • Las segmentaciones estándar tienen el campo estándar marcado como verdadero y en las personalizadas el campo estándar es nulo
  • La API debe aceptar el parámetro de búsqueda en path_params (?search=name)
  • Importante: la búsqueda no devuelve las segmentaciones predeterminadas

Lista de segmentaciones estándar:
{
        "contacts": [
            {
                "id": 4,
                "name": "Clientes (estágio no funil)",
                "standard": true,
                "created_at": "2021-12-24T11:52:12.046-03:00",
                "updated_at": "2021-12-24T11:52:12.046-03:00",
                "process_status": "processed",
                "links": [
                    {
                        "rel": "SEGMENTATIONS.CONTACTS",
                        "href": "https://api.rd.services/platform/segmentations/4/contacts",
                        "media": "application/json",
                        "type": "GET"
                    }
                ]
            },
            {
                "id": 2,
                "name": "Leads (estágio no funil)",
                "standard": true,
                "created_at": "2021-12-24T11:52:12.013-03:00",
                "updated_at": "2021-12-24T11:52:12.013-03:00",
                "process_status": "processed",
                "links": [
                    {
                        "rel": "SEGMENTATIONS.CONTACTS",
                        "href": "https://api.rd.services/platform/segmentations/2/contacts",
                        "media": "application/json",
                        "type": "GET"
                    }
                ]
            },
            {
                "id": 5,
                "name": "Oportunidades",
                "standard": true,
                "created_at": "2021-12-24T11:52:12.062-03:00",
                "updated_at": "2021-12-24T11:52:12.062-03:00",
                "process_status": "processed",
                "links": [
                    {
                        "rel": "SEGMENTATIONS.CONTACTS",
                        "href": "https://api.rd.services/platform/segmentations/5/contacts",
                        "media": "application/json",
                        "type": "GET"
                    }
                ]
            },
            {
                "id": 3,
                "name": "Leads Qualificados (estágio no funil)",
                "standard": true,
                "created_at": "2021-12-24T11:52:12.030-03:00",
                "updated_at": "2021-12-24T11:52:12.030-03:00",
                "process_status": "processed",
                "links": [
                    {
                        "rel": "SEGMENTATIONS.CONTACTS",
                        "href": "https://api.rd.services/platform/segmentations/3/contacts",
                        "media": "application/json",
                        "type": "GET"
                    }
                ]
            },
            {
                "id": 1,
                "name": "Todos os contatos da base de Leads",
                "standard": true,
                "created_at": "2021-12-24T11:52:12.030-03:00",
                "updated_at": "2021-12-24T11:52:12.030-03:00",
                "process_status": "processed",
                "links": [
                    {
                        "rel": "SEGMENTATIONS.CONTACTS",
                        "href": "https://api.rd.services/platform/segmentations/1/contacts",
                        "media": "application/json",
                        "type": "GET"
                    }
                ]
            }
        ]
      }