Segmentations list


Segmentation is a filter that selects leads from your base that have specific information, creating a dynamic list. With this, it is possible to create and carry out targeted Marketing actions, according to your needs within RD Station Marketing.

With this new API segmentation feature, you will be able to list all existing segmentations in your RD Station Marketing account and navigate to the list of all existing leads in the selected segmentation.

Available methods

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

Pagination
  • The api must accept the page and page_size parameters in path_params (?page=1&page_size=25)
  • The default value of the page parameter must be 1 and the page_size must be 25
  • The maximum size of the page_size parameter defined is 125 and if it is exceeded an error is returned
  • The pagination-total-rows, pagination-page-size and pagination-page headers must be returned
Ordination
  • The api must accept the order parameter (?order=name:desc)
  • The ordering accepts asc or desc, if not informed the default value is asc
  • The accepted fields for sorting the segmentations are: process_status, created_at and updated_at
Standard Segmentations
  • These are all those segmentations that were previously configured in RD Station Marketing
  • The Segmentations "All contacts in Lead base", "Customers (funnel stage)" and "Leads (funnel stage)" are examples of Standard Segmentations.
  • The standard segmentations have the standard field marked as true and in the custom ones the standard field is null
  • The api must accept the search parameter in path_params (?search=name)
  • Important: Default segmentations are not returned by search

List of standard segmentations:
{
        "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"
                    }
                ]
            }
        ]
      }