Segmentações

A segmentação é um filtro que seleciona os leads da sua base que possuem informações específicas, criando uma lista dinâmica. Com isso, é possível criar e realizar ações de Marketing direcionadas, de acordo com suas necessidades dentro do RD Station Marketing.

Com esse novo recurso de segmentação via API, você poderá listar todas as segmentações existentes na sua conta RD Station Marketing e navegar até a lista de todos os leads existentes na segmentação selecionada.

Métodos disponíveis

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

Paginação
  • A api deve aceitar os parâmetros page e page_size em path_params (?page=1&page_size=25)
  • O valor padrão do parâmetro page deve ser 1 e do page_size deve ser 25
  • O tamanho máximo do parâmetro page_size definido é 125 e caso seja excedido um erro é retornado
  • Os headers pagination-total-rows, pagination-page-size e pagination-page devem ser retornados
Ordenação
  • A api deve aceitar o parâmetro order (?order=name:desc)
  • A ordenação aceita asc ou desc, caso não seja informado o valor default é asc
  • Os campos aceitos para ordenação das segmentações são: process_status, created_at e updated_at
Segmentações Padrão
  • São todas aquelas segmentações que já estavam previamente configuradas no RD Station Marketing
  • As Segmentações "Todos os contatos da base de Leads", "Clientes (estágio no funil)" e "Leads (estágio no funil)" são exemplos de Segmentações Padrão.
  • As segmentações padrão tem o campo standard marcado como true e nas personalizadas o campo standard é nulo
  • A api deve aceitar o parâmetro search em path_params (?search=name)
  • Importante: As Segmentações Padrão não são retornadas pela busca

Lista das segmentações padrão:
{
        "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"
                    }
                ]
            }
        ]
      }