Alterações na API de Listar Distribuições

Visando uma melhor estruturação da resposta dos endpoints de “Listar todas distribuições de uma pesquisa” e “Listar uma distribuição” e na prevenção e correção de bugs, a partir do dia 27/03/2024 o modelo de retorno será alterado.

Solicitamos que tenha atenção aos pontos de alteração abaixo para que continue recebendo os dados corretamente. Os principais pontos de alteração foram:

Campos adicionados:

• Adição do campo failed;

• Adição do campo "survey_hash".

Campos retirados:

• Retirada dos campos: "bounce", "dropped", "spam_report" e "deferred".

• Retirada dos campos: "duplicated", "unsubscribed" e "quarantine", esses poderão ser consultados nos campos:

  • "error_duplicated_customer_counter",

  • "error_duplicated_channel_counter",

  • "error_unsubscribed_channel_counter" e

  • "error_quarantine_counter".

• Retirada dos campos a seguir devido a duplicidade desnecessária:

  • "error_no_customer_counter"

  • "error_duplicated_customer_counter"

  • "error_duplicated_channel_counter"

  • "error_unsubscribed_channel_counter"

  • "error_unknown_channel_counter"

  • "error_blockrule_counter"

  • "error_blocked_counter"

  • "error_quarantine_counter"

  • "error_no_channel_counter"

  • "error_identifier_format_counter"

  • "error_channel_attribute_format_counter"

  • "error_parse_counter"

Com as alterações listadas, o retorno dos endpoints passam a seguir o seguinte formato:

{
    "data": {
        "distribution": [
            {
                "uuid": "...",//string
                "distribution_name": "...",//string
                "distribution_chanel": "...",//int
                "survey_uuid": "...",//string
                "survey_name": "...",//string
                "schedule_at": "...",//time
                "validity_at": "...",//time
                "reminder_at": "...",//time
                "counter": "...",//int
                "distributed_at":  "...",//time
                "added": "...",//int
                "valid": "...",//int
                "processed": "...",//int
                "delivered": "...",//int
                "opened": "...",//int
                "clicked": "...",//int
                "failed":  "...",//int
                "answered": "...",//int
                "done":  "...",//int
                "partial": "...",//int
                "invalid": "...",//int
                "not_delivered":  "...",//int
                "invalid_errors": {
                               "error_no_customer_counter": "...",//int   
                               "error_duplicated_customer_counter": "...",//int
                               "error_duplicated_channel_counter": "...",//int
                               "error_unknown_channel_counter": "...",//int
                               "error_no_channel_counter": "...",//int
                               "error_identifier_format_counter": "...",//int
                               "error_channel_attribute_format_counter":                                                                                                                                                                
                               "...",//int
                               "error_parse_counter": "...",//int
                },
                "not_delivered_errors": {
                               "error_unsubscribed_channel_counter": "...",//int
                               "error_blockrule_counter": "...",//int
                               "error_blocked_counter": "...",//int
                               "error_quarantine_counter": "...",//int
                 },
                "total_processed_counter": "...",//int
                "error_response_counter":  "...",//int
                "sender_type": "...",//int
                "distribution_hash": "...",//string
                "survey_hash": "...",//string
                "organization_hash": "...",//string
                "created_at": "..."//time
            }
        ]
    },
    "success": "success",
    "message": ""
}"