Перейти к основному содержимому

Аналитика | Документация для разработчиков

Аналитика

Обновлено: 12 февраля 2026 г
Начиная с 1 декабря 2025 года максимальный период ретроспективного анализа для анализа сообщений, переписок и ценообразования изменяется с 10 лет до 1 года. Период ретроспективного анализа для анализа шаблонов и групп шаблонов останется без изменений и будет по-прежнему составлять 90 дней.
В этом документе описывается, как получить аналитику по сообщениям, беседам, шаблонам и группам, например, количество сообщений, отправленных с корпоративного номера телефона, количество бесед и их стоимость для бизнес-аккаунта WhatsApp (WABA), или количество прочтений определенного шаблона.
В ответы будут включены только показатели по номерам телефонов компаний и шаблонам, связанным с вашей системой WABA на момент запроса.

Получить данные

Используйте GET / Конечная точка для получения аналитических данных.

Запрос синтаксис

curl -g 'https://graph.facebook.com/<API_VERSION> /<WHATSAPP_BUSINESS_ACCOUNT_ID> ?fields=<FIELD> .<FILTERS> ' \ -H 'Авторизация: Предъявитель<ACCESS_TOKEN> '
Параметры запроса








Заполнитель 

Описание 

Пример значения 






<FIELD>







аналитика






<FILTERS>





Необходимый.


Параметр фильтрации метрик. Добавьте дополнительные параметры фильтрации, используя точки.


Возможные значения см. в:


    Параметры аналитики сообщенийПараметры анализа разговоровПараметры анализа шаблоновПараметры аналитики групп шаблоновПараметры анализа звонковПараметры групповой аналитики
    


    

    .start(1543543200).end(1544148000).granularity(DAY)
    

    

    

    

    Обмен сообщениямиЦены аналитика
    

    Он аналитикаценовая аналитика поле предоставляетпозволяет тотты числок иполучать типценообразование изполомки для любого сообщения отправлено и доставленный по номерам телефонов, связанным св пределах а специфическийуказанный ВАБАдата —диапазон.
    
для
    
беседа
    
метрики,
    
видеть
    Запрос Беседасинтаксис
    
Аналитика.
    
Когда
    ПОЛУЧАТЬ звонок /<WHATSAPP_BUSINESS_ACCOUNT_ID>
  ?fields=аналитика.{параметры фильтрации},ценовая аналитика
  ты.начинать(<START> )
  может.конец(<END> )
  прикреплять.granularity(<GRANULARITY> )
  тот.phone_numbers(<PHONE_NUMBERS> )
  следующий.country_codes(<COUNTRY_CODES> )
  параметры..metric_types(<METRIC_TYPES> ) .pricing_types(<PRICING_TYPES> ) .pricing_categories(<PRICING_CATEGORIES> ) .размеры(<DIMENSIONS> )
    

    

    

    

    Обмен сообщениямиЦены аналитические параметры
    

    

    



ИмяФильтр 
Описание Описание
Пример значения 




    

    начинать<COUNTRY_CODES>
    

    тип:Множество UNIXиз Отметка временистроки
    


    Необходимый.
    Он
начальная дата для диапазона дат, за который вы получаете аналитические данные.
    конец
    тип: метка времени UNIX
    Необходимый.
    Конечная дата для диапазона дат, за который вы получаете аналитические данные.
    детализация
    тип: Строка
    Необходимый.
    Уровень детализации, с которым вы хотите получать аналитические данные. Поддерживаемые параметры:
      ПОЛЧАСАДЕНЬМЕСЯЦ
      номера телефонов
      тип: Массив
      Необязательный.
      Ан
Массив телефонных номеров, для которых вы хотите получить аналитические данные. Если не указан, будут включены все телефонные номера, добавленные в ваш WABA-архив.
      тип_продукта
      тип: Массив
      Необязательный.
      Типы сообщений (уведомления и/или сообщения службы поддержки клиентов), для которых вы хотите получать уведомления. Если не указано, аналитика будет возвращена для всех сообщений вместе.
      Поддерживаемые значения:
        0 — для шаблонных сообщений, отправляемых пользователям WhatsApp2 — для сообщений, не являющихся шаблонами, отправленных пользователям WhatsApp100 — для входящих сообщений, отправленных вам пользователями WhatsApp
        коды стран
        тип: Массив
        Необязательный.
        Укажите страны, для которых вы хотите получить аналитические данные. Предоставьте массив с двухбуквенными кодами стран, которые вы хотите включить. Если данные не указаны, будут возвращены аналитические данные для всех стран, с которыми вы взаимодействовали.
        


        Пример
        Сценарий:
Вам необходимо получить количество сообщений, отправленных и доставленных всеми телефонными номерами, связанными с вашим WABA-сервером.
        Предложенное решение: Используйте следующие параметры фильтрации: начинать, конец, детализация.
        curl -i -X ​​GET "https://graph.facebook.com/v25.0/102290129340398 ?fields=analytics .start(1543543200) .end(1544148000) .granularity(DAY) &access_token=BLI8lkj..."

        Успешный ответ возвращает аналитика объект с запрошенными вами данными:
        { "analytics": { "phone_numbers": [ "16505550111", "16505550112", "16505550113" ], "country_codes": [ "US", "BR" ], "granularity": "DAY", "data_points": [ { "start": 1543543200, "end": 1543629600, "sent": 196093, "delivered": 179715 }, { "start": 1543629600, "end": 1543716000, "sent": 147649, "delivered": 139032 }, { "start": 1543716000, "end": 1543802400, "sent": 61988, "доставлено": 58830 }, { "начало": 1543802400, "конец": 1543888800, "отправлено": 132465, "доставлено": 124392 } # больше точек данных ] }, "id": "102290129340398" }
        Аналитика разговоров
        Он аналитика разговоров поле предоставляет информацию о стоимости и беседа Информация для конкретного WABA. При звонке /<WHATSAPP_BUSINESS_ACCOUNT_ID> ?fields=conversation_analytics.{filtering-parameters}Вы можете добавить следующие параметры.
        Параметры анализа разговоров
        
Имя

Описание (Для просмотра поддерживаемых параметров нажмите стрелку в левой колонке.)
        начинать
        тип: метка времени UNIX
        Необходимый.
        Начальная дата для диапазона дат, за который вы получаете аналитические данные.
        конец
        тип: метка времени UNIX
        Необходимый.
        Конечная дата для диапазона дат, за который вы получаете аналитические данные.
        детализация
        тип: Строка
        Необходимый.
        Уровень детализации, с которым вы хотите получать аналитические данные. Поддерживаемые параметры:
          ПОЛЧАСАЕЖЕДНЕВНОЕЖЕМЕСЯЧНО
          номера телефонов
          тип: Массив
          Необязательный.
          Массив телефонных номеров, для которых вы хотите получить аналитические данные. Если не указан, будут включены все телефонные номера, добавленные в ваш WABA-архив.
          metric_types
          Необязательный.
          Список метрик, которые вы хотели бы получать. Если вы отправите пустой список, мы вернем результаты для всех типов метрик.
          Поддерживаемые параметры: {#supported}
            РАСХОДЫВключает приблизительные расценки за указанный период времени в валюте WABA.БЕСЕДА: Включает количество разговоров за указанный период времени.
            Исключение:
            РАСХОДЫ Возврат средств не производится для WABA, использующих кредитную линию партнера по решениям. Если ваш WABA использует кредитную линию партнера по решениям, свяжитесь с вашим партнером по решениям, чтобы уточнить размер ваших платежей. Если вы обращаетесь к WABA, которая использует ту же кредитную линию, что и партнер по решениям:
              Если нет metric_types указаны только в вашем запросе БЕСЕДА возвращается.Если бы только БЕСЕДА указано, только БЕСЕДА возвращается.Если бы только РАСХОДЫ Если указано иное, возвращается следующее исключение:
            
                Заголовок: «Стоимость не указана»Сообщение: «Стоимость больше не отображается для компаний, выставляющих счета через партнера (например, BSP). Чтобы узнать подробности о ваших платежах, пожалуйста, свяжитесь со своим партнером»
                Если вы запрашиваете данные за период времени, включающий даты, начинающиеся 1 июля 2023 года или позже (например, с 1 мая 2023 года по 1 августа 2023 года), в ответе будет указано вышеуказанное исключение.
                Это не относится к случаям запроса к аналитика разговоров конечная точка.
                категории_разговора
                Необязательный.
                Список категории разговораЕсли вы отправите пустой список, мы вернем результаты для всех категорий бесед.
                Поддерживаемые параметры:
                  АутентификацияМАРКЕТИНГУСЛУГАКОММУНАЛЬНЫЕ УСЛУГИ
                  conversation_types
                  Необязательный.
                  Список типов диалогов. Если вы отправите пустой список, мы вернем результаты для всех типов диалогов. Поддерживаемые параметры:
                    БЕСПЛАТНЫЙ ВХОДРазговоры, исходящие из бесплатный вход.БЕСПЛАТНЫЙ_УРОВЕНЬ: Беседы в рамках ежемесячного выпуска бесплатный уровень.ОБЫЧНЫЙЛюбые разговоры, которые не были инициированы кем-либо из [название компании] бесплатный вход или превышают ежемесячный лимит бесплатного доступа.
                    направления разговора
                    Необязательный.
                    Список вариантов развития диалога. Если вы отправите пустой список, мы вернем результаты для всех вариантов развития диалога. Поддерживаемые параметры:
                      ИНИЦИИРОВАННЫЙ БИЗНЕС: Разговоры, инициированные компанией.ИНИЦИИРОВАННЫЙ ПОЛЬЗОВАТЕЛЕМ: Диалоги, инициированные конечным пользователем/клиентом.НЕИЗВЕСТНЫЙСистема не может определить направление.
                      размеры
                      Необязательный.
                      Список вариантов разбивки, которые вы хотите применить к своим метрикам. Если вы отправите пустой список, мы вернем результаты без каких-либо вариантов разбивки. Поддерживаемые параметры:
                        КАТЕГОРИЯ_РАЗГОВОРАНАПРАВЛЕНИЕ_РАЗГОВОРАТИП_РАЗГОВОРАСТРАНАТЕЛЕФОН
                        Аналитические данные являются приблизительными и могут отличаться от данных, указанных в счетах-фактурах, из-за небольших расхождений в обработке данных.
                        Примеры
                        Задав временной диапазон, вы можете получить информацию о конверсии и стоимости, связанную с вашей WABA. При желании вы можете отфильтровать и детализировать результаты. Примеры кода приведены ниже.
                        Получайте ежемесячные данные со всеми разбивками
                        Сценарий:  Вам необходимо получить информацию о всех разговорах и расходах по всем телефонным номерам, связанным с определенным номером WABA, за определенный месяц.
                        Предложенное решение: Используйте следующие параметры фильтрации:
                          начинать: Начало вашего временного диапазона. В данном случае, начало месяца, за который вы хотите получить показатели.конецКонец указанного вами временного диапазона. В данном случае, это конец месяца, за который вам нужны показатели.детализация: Насколько детализированными вы хотите сделать ваши точки данных. В приведенном ниже примере мы используем ЕЖЕМЕСЯЧНОТаким образом, каждая точка данных будет представлять собой данные за один месяц.номера телефоновОтправьте пустой массив, и мы вернем информацию обо всех телефонных номерах, связанных с WABA.размерыУстановите значение «Все доступные варианты детализации»: "КАТЕГОРИЯ_РАЗГОВОРА", "ТИП_РАЗГОВОРА", "СТРАНА", и "ТЕЛЕФОН".
                          В этом случае указывать не нужно коды стран, metric_types, conversation_types и категории_разговораЕсли вы ничего не укажете в этих полях, мы вернем все доступные варианты. После настройки URL-адреса выполните GET-запрос:
                          curl -i -X ​​GET "https://graph.facebook.com/v25.0/102290129340398 ?fields=conversation_analytics .start(1685602800).end(1688194800) .granularity(MONTHLY) .phone_numbers([]) .dimensions(["CONVERSATION_CATEGORY","CONVERSATION_TYPE","COUNTRY","PHONE"]) &access_token=BLI8lkj..."

                          В случае успешного ответа возвращается аналитика разговоров Объект с запрошенными вами данными. В следующем примере WABA содержит только один номер телефона.
                          { "conversation_analytics": { "data": [ { "data_points": [ { "start": 1685602800, "end": 1688194800, "conversation": 1558, "phone_number": "15550458206", "country": "US", "conversation_type": "REGULAR", "conversation_direction": "UNKNOWN", "conversation_category": "AUTHENTICATION", "cost": 15.58 }, { "start": 1685602800, "end": 1688194800, "conversation": 2636, "phone_number": "15550458206", "country": "US", "conversation_type": "REGULAR", "conversation_category": "MARKETING", "cost": 26.36 }, { "start": 1685602800, "end": 1688194800, "conversation": 2238, "phone_number": "15550458206", "country": "US", "conversation_type": "REGULAR", "conversation_category": "SERVICE", "cost": 22.38 }, { "start": 1685602800, "end": 1688194800, "conversation": 1782, "phone_number": "15550458206", "country": "US", "conversation_type": "REGULAR", "conversation_category": "UTILITY", "cost": 17.82 }, { "start": 1685602800, "end": 1688194800, "разговор": 1568, "номер_телефона": "15550458206", "страна": "США", "тип_разговора": "бесплатный_уровень", "категория_разговора": "аутентификация", "стоимость": 15.68 }, { "начало": 1685602800, "конец": 1688194800, "разговор": 2716, "номер_телефона": "15550458206", "страна": "США", "тип_разговора": "бесплатный_уровень", "категория_разговора": "маркетинг", "стоимость": 27.16 }, { "начало": 1685602800, "конец": 1688194800, "разговор": 2180, { "номер_телефона": "15550458206", "страна": "США", "тип_разговора": "бесплатный_уровень", "категория_разговора": "услуга", "стоимость": 21.8 }, { "начало": 1685602800, "конец": 1688194800, "разговор": 1465, "номер_телефона": "15550458206", "страна": "США", "тип_разговора": "бесплатный_уровень", "категория_разговора": "коммунальные услуги", "стоимость": 14.65 }, { "начало": 1685602800, "конец": 1688194800, "разговор": 1433, "номер_телефона": "15550458206", "страна": "США", "conversation_type": "FREE_ENTRY_POINT", "conversation_category": "SERVICE", "cost": 14.33 } ] } ] }, "id": "102290129340398", }
                          Получите данные по конкретному номеру телефона, используя все варианты и получасовую детализацию
                          СценарийВам необходимо получить всю информацию о разговорах и стоимости звонков для конкретного телефонного номера, связанного с WABA-кодом, задав временной диапазон. В результатах следует использовать все возможные варианты детализации. Каждая точка данных должна представлять данные за полчаса.
                          Предложенное решениеИспользуйте следующие параметры фильтрации:
                            начинатьНачало вашего временного диапазона.конец: Конец вашего временного диапазона.детализация: Насколько детализированными вы хотите сделать ваши точки данных. В приведенном ниже примере мы используем ПОЛЧАСАТаким образом, каждая точка данных представляет собой данные за полчаса.номера телефоновНомер телефона, по которому вам нужна информация.размерыУстановите значение «Все доступные варианты детализации»: КАТЕГОРИЯ_РАЗГОВОРА, ТИП_РАЗГОВОРА, СТРАНА, и ТЕЛЕФОН.
                            В этом случае указывать не нужно коды стран, metric_types, conversation_types, или категории_разговораЕсли вы ничего не укажете в этих полях, мы вернем все доступные варианты. После настройки URL-адреса выполните GET-запрос:
                            curl -i -X ​​GET \ "https://graph.facebook.com/v25.0/102290129340398 ?fields=conversation_analytics .start(1685602800) .end(1685689200) .granularity(HALF_HOUR) .phone_numbers(["19195552584"]) .dimensions(["CONVERSATION_CATEGORY","CONVERSATION_TYPE","COUNTRY,PHONE"]) &access_token=BLI8lkj..."

                            В случае успешного ответа возвращается аналитика разговоров объект с запрошенными вами данными:
                            { "conversation_analytics": { "data": [ { "data_points": [ { "start": 1685602800, "end": 1685604600, "conversation": 4, "phone_number": "19195552584", "country": "US", "conversation_type": "REGULAR", "conversation_direction": "UNKNOWN", "conversation_category": "SERVICE", "cost": 0.0232 }, { "start": 1685602800, "end": 1685604600, "conversation": 4, "phone_number": "19195552584", "country": "US", "conversation_type": "REGULAR", "conversation_direction": "UNKNOWN", "conversation_category": "MARKETING", "стоимость": 0.0232 }, # ... больше точек данных ] } ] }, "id": "102290129340398" }
                            Получайте ежемесячные данные с разбивкой по типам разговоров
                            СценарийВам необходимо получить информацию о всех телефонных разговорах и стоимости звонков для всех номеров, связанных с WABA-кодом, задав временной диапазон. В результатах необходимо указать разбивку по типу разговора.
                            Предложенное решениеИспользуйте следующие параметры фильтрации:
                              начинатьНачало вашего временного диапазона.конец: Конец вашего временного диапазона.детализация: Насколько детализированными вы хотите сделать ваши точки данных. В приведенном ниже примере мы используем ЕЖЕМЕСЯЧНОТаким образом, каждая точка данных представляет собой данные за половину месяца.номера телефоновОтправьте пустой массив, и мы вернем информацию обо всех телефонных номерах, связанных с WABA.размерыУстановите значение ТИП_РАЗГОВОРА.
                              В этом случае указывать не нужно коды стран, metric_types, conversation_types, направления разговора, или категории_разговораЕсли вы ничего не укажете в этих полях, мы вернем все доступные варианты. После настройки URL-адреса выполните GET-запрос:
                              curl -i -X ​​GET "https://graph.facebook.com/v25.0/102290129340398 ?fields=conversation_analytics .start(1643702400).end(1646121600) .granularity(MONTHLY) .phone_numbers([]) .dimensions([CONVERSATION_TYPE]) &access_token=BLI8lkj..."

                              В случае успешного ответа возвращается аналитика разговоров объект с запрошенными вами данными:
                              { "data": [ { "data_points": [ { "start": 1643702400, "end": 1646121600, "conversation": 8500, "conversation_type": "REGULAR", "cost": 88.1010 }, { "start": 1643702400, "end": 1646121600, "conversation": 1000, "conversation_type": "FREE_TIER", "cost": 0.0000 } { "start": 1643702400, "end": 1646121600, "conversation": 250, "conversation_type": "FREE_ENTRY_POINT", "cost": 0.0000 } ] } ] }
                              Получите данные за полчаса, разбитые по категориям разговоров
                              Запрос:
                              curl -i -X ​​GET "https://graph.facebook.com/v25.0/102290129340398 ?fields=conversation_analytics .start(1685527200) .end(1685613600) .granularity(HALF_HOUR) .conversation_categories(["MARKETING","AUTHENTICATION"]) .dimensions(["CONVERSATION_CATEGORY"]) &access_token=BLI8lkj..."

                              Ответ:
                              { "conversation_analytics": { "data": [ { "data_points": [ { "start": 1685529000, "end": 1685530800, "conversation": 2, "conversation_category": "AUTHENTICATION", "cost": 0.0128 }, { "start": 1685527200, "end": 1685529000, "conversation": 3, "conversation_category": "MARKETING", "cost": 0.0432 } ] } ] }, "id": "102290129340398" }
                              Получите данные за полчаса с разбивкой по категориям и типам разговоров
                              Запрос:
                              curl -i -X ​​GET \ "https://graph.facebook.com/v25.0/102290129340398 ?fields=conversation_analytics .start(1685527200) .end(1685613600) .granularity(HALF_HOUR) .conversation_categories(["MARKETING","AUTHENTICATION"]) .dimensions(["CONVERSATION_CATEGORY","CONVERSATION_TYPE"]) &access_token=BLI8lkj..."

                              Ответ:
                              { "conversation_analytics": { "data": [ { "data_points": [ { "start": 1685527200, "end": 1685529000, "conversation": 3, "conversation_type": "REGULAR", "conversation_category": "MARKETING", "cost": 0.0432 }, { "start": 1685529000, "end": 1685530800, "conversation": 2, "conversation_type": "REGULAR", "conversation_category": "AUTHENTICATION", "cost": 0.0128 } ] } ] }, "id": "102290129340398" }
                              Анализ ценообразования
                              Он ценовая аналитика Это поле позволяет получить подробную информацию о ценах на любые сообщения, доставленные в указанном диапазоне дат.
                              Синтаксис запроса
                              ПОЛУЧАТЬ /<WHATSAPP_BUSINESS_ACCOUNT_ID> ?fields=pricing_analytics .start(<START> ) .конец(<END> ) .granularity(<GRANULARITY> ) .phone_numbers(<PHONE_NUMBERS> ) .country_codes(<COUNTRY_CODES> ) .metric_types(<METRIC_TYPES> ) .pricing_types(<PRICING_TYPES> ) .pricing_categories(<PRICING_CATEGORIES> ) .размеры(<DIMENSIONS> )
                              Параметры ценовой аналитики
                              
Фильтр

Описание

Пример значения

                              <COUNTRY_CODES>
                              Массив строк
                              Необязательный.
                              Укажите страны, для которых вы хотите получить аналитические данные. Предоставьте массив с двухбуквенными кодами стран, которые вы хотите включить. Если данные не указаны, будут возвращены аналитические данные для всех стран, с которыми вы взаимодействовали.
                              [США, Бразилия]
                              



                              

                              <DIMENSIONS>
                              

                              Массив строк
                              


                              

                              Необязательный.
                              

                              Список параметров, которые вы хотите применить к своим метрикам. Если вы отправите пустой список, мы вернем результаты без каких-либо параметров.
                              

                              Возможные значения:
                              

                                СТРАНАТЕЛЕФОНКАТЕГОРИЯ_ЦЕНООБРАЗОВАНИЯТИП_ЦЕНЫУРОВЕНЬ
                                


                                

                                [ PRICING_CATEGORY, PRICING_TYPE, COUNTRY ]
                                



                                

                                <END>
                                

                                метка времени UNIX
                                


                                

                                Необходимый.
                                

                                Метка времени UNIX, указывающая конечную дату диапазона дат, за который вы получаете аналитические данные.
                                


                                

                                1728581152
                                



                                

                                <GRANULARITY>
                                

                                Нить
                                


                                

                                Необходимый.
                                

                                Уровень детализации, с которым вы хотите получать аналитические данные. Значение может быть одним из следующих:
                                

                                  ЕЖЕДНЕВНОПОЛЧАСАЕЖЕМЕСЯЧНО
                                  


                                  

                                  ЕЖЕДНЕВНО
                                  



                                  

                                  <METRIC_TYPES>
                                  

                                  Массив строк
                                  


                                  

                                  Необязательный.
                                  

                                  Массив метрик, которые вы хотите получить. Если вы отправите пустой массив, мы вернем результаты для всех типов метрик.
                                  

                                  Возможные значения:
                                  

                                    РАСХОДЫПримерная стоимость сообщений, доставленных в указанный период времени, в вашем регионе ВАБАВАБАвалюта.ОБЪЕМ: Включает количество сообщений, доставленных за указанный период времени.

                                    Обратите внимание, что РАСХОДЫ Возврат средств за WABA, использующие одно и то же решение, не предусмотрен ПартнерПартнеркредитная линия. Если ваш WABA предоставляет решение ПартнерПартнерДля уточнения информации о кредитной линии обратитесь к своему партнеру по решениям.
                                    


                                    

                                    [СТОИМОСТЬ, ОБЪЕМ]
                                    



                                    

                                    <PHONE_NUMBERS>
                                    

                                    Массив строк
                                    


                                    

                                    Необязательный.
                                    

                                    Массив телефонных номеров, для которых вы хотите получить аналитические данные. Если не указан, будут включены данные по всем корпоративным телефонным номерам, связанным с вашей базой данных WABA.
                                    


                                    

                                    [
15550783881,
15550783882,
15550783883
]
                                    



                                    

                                    <PRICING_CATEGORIES>
                                    

                                    Массив строк
                                    


                                    

                                    Необязательный.
                                    

                                    Массив ценовых категорий. Если вы отправите пустой массив, мы вернем результаты для всех ценовых категорий.
                                    

                                    Возможные значения:
                                    

                                      АУТЕНТИФИКАЦИЯ: За сообщения взимается плата за аутентификацию.AUTHENTICATION_INTERNATIONAL: Сообщения обрабатываются по международному тарифу аутентификации.МАРКЕТИНГ: За сообщения взимается плата по маркетинговому тарифу.ОБСЛУЖИВАНИЕ: Сообщения, за которые не была произведена оплата. Включает все сообщения, не являющиеся шаблонами, и служебные сообщения, отправленные в течение периода обслуживания клиентов.КОММУНАЛЬНЫЕ УСЛУГИ: За сообщения взимается плата по тарифу коммунальных услуг.REFERRAL_CONVERSION: Сообщения, полученные через бесплатную точку входа.
                                      


                                      

                                      [Аутентификация, маркетинг, полезность]
                                      



                                      

                                      <PRICING_TYPES>
                                      

                                      Массив строк
                                      


                                      

                                      Необязательный.
                                      

                                      Массив типов ценообразования. Если вы отправите пустой массив, мы вернем результаты для всех типов ценообразования.
                                      

                                      Возможные значения:
                                      

                                        FREE_CUSTOMER_SERVICE: Бесплатные сообщения. Это сообщения, не являющиеся шаблонами, и служебные сообщения, отправляемые в рамках работы службы поддержки клиентов.FREE_ENTRY_POINT: Все сообщения, отправленные в рамках времени работы службы поддержки клиентов Free Entry Point.ОБЫЧНЫЙ ВАРИАНТ: Платные сообщения. Включает все шаблонные сообщения для аутентификации и маркетинга, а также любые служебные шаблонные сообщения, отправленные вне установленного окна обслуживания клиентов. Исключает все сообщения, отправленные в рамках бесплатного окна обслуживания клиентов.
                                        


                                        

                                        [ОБЫЧНОЕ, БЕСПЛАТНОЕ ОБСЛУЖИВАНИЕ КЛИЕНТОВ]
                                        



                                        

                                        <START>
                                        

                                        метка времени UNIX
                                        


                                        

                                        Необходимый.
                                        

                                        Временная метка UNIX, указывающая начальную дату диапазона дат, за который вы получаете аналитические данные.
                                        


                                        

                                        1726014453
                                        



                                        

                                        <WABA_ID>
                                        

                                        Нить
                                        


                                        

                                        Необходимый.
                                        

                                        Идентификатор бизнес-аккаунта WhatsApp.
                                        


                                        

                                        102290129340398
                                        

                                        

                                        

                                        

                                        Информация об уровне объема
                                        

                                        добавьте TIER, PRICING_CATEGORYи COUNTRY в измерений . Точки данных, представляющие сообщения, на которые влияют тарифные планы объемов, будут иметь tier в ответе.
                                        

                                        

                                        

                                        

                                        Пример синтаксиса ответа с информацией об уровне
                                        

                                        

                                        {
                                        
"начинать":<START_TIMESTAMP> , "конец":<END_TIMESTAMP> , "номер телефона": "<BUSINESS_PHONE_NUMBER> ", "страна": "<COUNTRY_CODE> ", "уровень": "<LOWER> :<UPPER> ", "pricing_type": "<PRICING_TYPE> ", "pricing_category": "<PRICING_CATEGORY> ", "объем":<VOLUME> , "расходы":<COST> }
                                        Он уровень Стоимость недвижимости представляет собой сумму нижнего и верхнего пределов для соответствующего уровня рынок-рынок-пара категорий (страна и ценовая_категория) что представляет собой эта точка данных.
                                        

                                          <LOWER> –- Целое число, представляющее нижнюю границу уровня (включительно).<UPPER> –- Целое число, представляющее верхнюю границу уровня (включительно), или строка МАКС.

                                          Примечания
                                          

                                            Чтобы определить свой текущий тарифный план, ознакомьтесь с информацией по ссылке уровень, страна, и ценовая_категория ценности уровень ценить'ценить'с <UPPER> Целое число (число после двоеточия) указывает ваш текущий уровень страна и ценовая_категория (например, (Индия и коммунальные услуги, соответственно).Чтобы определить, сколько сообщений нужно отправить, чтобы перейти на следующий уровень для данного уровня страна и ценовая_категориявычтите объем целое число из уровня ценить'ценить'с <UPPER> целое число.Уровни объема будут доступны только для служебных сообщений и сообщений-шаблонов аутентификации. Для маркетинговых сообщений-шаблонов (где уровни объема не применяются) уровень будет установлен на 0:MAX.Он уровень Для точек данных, представляющих бесплатные сообщения, свойство будет опущено, поскольку бесплатные сообщения дон'дон'не вносят вклад в подсчет уровней.Уровни объема будут определяться исключительно Meta. Все данные аналитики являются приблизительными из-за небольших расхождений в обработке данных. Не следует чрезмерно полагаться на данные аналитики.

                                            

                                            

                                            

                                            Пример запроса
                                            

                                            локон
                                            
'https://graph.facebook.com/v25.0/161311403722088?fields=pricing_analytics.start(1748761200).end(1749687703).granularity(DAILY).dimensions(PRICING_CATEGORY,PRICING_TYPE,TIER,COUNTRY).country_codes(US,IN)'
                                            
\
                                            
-ЧАС
                                            
«Авторизация: Предъявитель EAAJB»

                                            Пример ответа
                                            

                                            

                                            {
                                            
"pricing_analytics":
                                            
{
                                            
"данные":
                                            
[ { "data_points": [ { "start": 1749193200, "end": 1749279600, "country": "IN", "pricing_type": "FREE_CUSTOMER_SERVICE", "pricing_category": "SERVICE", "volume": 2, "cost": 0 }, { "start": 1749106800, "end": 1749193200, "country": "IN", "tier": "0:750000", "pricing_type": "REGULAR", "pricing_category": "AUTHENTICATION_INTERNATIONAL", "volume": 2, "cost": 4.6 }, { "start": 1749106800, "end": 1749193200, "country": "IN", "pricing_type": "БЕСПЛАТНОЕ ОБСЛУЖИВАНИЕ КЛИЕНТОВ", "Категория цен": "ОБСЛУЖИВАНИЕ", "Объем": 2, "Стоимость": 0 }, { "начало": 1748934000, "конец": 1749020400, "страна": "США", "уровень": "0:MAX", "тип_цены": "ОБЫЧНЫЙ", "Категория_цены": "МАРКЕТИНГ", "объем": 1, "стоимость": 10 }, { "начало": 1748847600, "конец": 1748934000, "страна": "США", "тип_цены": "БЕСПЛАТНОЕ ОБСЛУЖИВАНИЕ КЛИЕНТОВ", "Категория_цены": "ОБСЛУЖИВАНИЕ", "объем": 1, "стоимость": 0 }, { "начало": 1748847600, "конец": 1748934000, "страна": { "США", "тип_цены": "пункт_бесплатного_входа", "категория_цены": "услуга", "объем": 6, "стоимость": 0 }, { "начало": 1748847600, "конец": 1748934000, "страна": "США", "уровень": "0:2", "тип_цены": "обычный", "категория_цены": "аутентификация", "объем": 1, "стоимость": 10 }, { "начало": 1748847600, "конец": 1748934000, "страна": "внутри", "уровень": "0:750000", "тип_цены": "обычный", "категория_цены": "международная_аутентификация", "объем": 1, "стоимость": 2.3 }, { "начало": 1748761200, "конец": 1748847600, "страна": "США", "тип_цены": "БЕСПЛАТНОЕ_ОБСЛУЖИВАНИЕ_КЛИЕНТОВ", "категория_цены": "СЕРВИС", "объем": 2, "стоимость": 0 }, { "начало": 1748761200, "конец": 1748847600, "страна": "США", "уровень": "0:2", "тип_цены": "ОБЫЧНЫЙ", "категория_цены": "АВТЕНТИКАЦИЯ", "объем": 1, "стоимость": 10 }, { "начало": 1748761200, "конец": 1748847600, "страна": "США", "тип_цены": "БЕСПЛАТНОЕ_ОБСЛУЖИВАНИЕ_КЛИЕНТОВ", "категория_цены": "КОММУНАЛЬНЫЕ УСЛУГИ", "объем": 1, "стоимость": 0 }, { "начало": 1748761200, "конец": 1748847600, "страна": "США", "уровень": "0:2", "тип_цены": "обычный", "категория_цены": "коммунальный", "объем": 1, "стоимость": 10 }, { "начало": 1748761200, "конец": 1748847600, "страна": "США", "уровень": "0:MAX", "тип_цены": "обычный", "категория_цены": "маркетинг", "объем": 4, "стоимость": 40 }, { "начало": 1748761200, "конец": 1748847600, "страна": "США", "уровень": "0:MAX", "тип_цены": "обычный", "категория_цены": "MARKETING_LITE", "volume": 1, "cost": 10 } ] } ] } }
                                            Аналитика шаблонов
                                            

                                            Аналитика шаблонов показывает количество отправленных, доставленных и прочитанных шаблонов, а также количество кликов по кнопкам URL или кнопкам быстрого ответа в шаблоне. Кроме того, интегрированный API MM для WhatsApp Business позволяет отслеживать показатели конверсии вне сайта.
                                            

                                            Данные возвращаются с точностью до дня в часовом поясе UTC по умолчанию ВАБАВАБАчасовой пояс, с периодом ретроспективного анализа до 90 дней. Для отображения данных в ВАБАВАБАДля заданного часового пояса передайте параметр use_waba_timezone со значением true.
                                            

                                            Отображение данных в ВАБАВАБАs — заданный часовой пояс путем передачи параметра use_waba_timezone параметр со значением истинный.
                                            

                                            

                                            {
                                            
"данные":
                                            
[
                                            
{
                                            
"waba_timezone": "America/Los_Angeles", "granularity": "DAILY", "product_type": "cloud_api", "data_points": [ ... ] } }
                                            Ограничения
                                            

                                              Аналитика кликов по кнопкам доступна только для шаблонов, отнесенных к категориям МАРКЕТИНГ или ПОЛЕЗНЫЕ ИНСТРУМЕНТЫ.WABA-аккаунты, принадлежащие или используемые совместно с Meta Business Accounts в Европейском Союзе, Соединенном Королевстве или Японии, или имеющие бизнес-номер с кодом страны из любой из этих стран или регионов, не поддерживаются.Показатели конверсии вне сайта доступны исключительно для компаний, подключенных к MM API для WhatsApp.Данные о прочтении и кликах по шаблонным сообщениям WhatsApp доступны только в течение 7 дней с момента отправки сообщения. По истечении этого 7-дневного периода соответствующие счетчики прочтений/кликов обнуляются, и дальнейшие обновления для этих сообщений не регистрируются.

                                              

                                              

                                              

                                              Подтверждение аналитики шаблона
                                              

                                              Для получения аналитики по шаблонам необходимо подтвердить ее в своем аккаунте WhatsApp Business. Подтвердить ее можно с помощью WhatsApp Manager или API.
                                              

                                              

                                              Подтвердив доступ через API, вы даёте Meta разрешение на добавление аналитических данных в ваш бизнес-аккаунт WhatsApp. Эти данные включают отслеживание ссылок для составления отчётов о переходах на веб-сайты. Вы можете отключить отслеживание ссылок в каждом шаблоне сообщения. Вы также даёте Meta разрешение на сбор и анонимизацию данных из ваших чатов с клиентами. Meta будет анонимизировать эти данные для улучшения предоставляемых вам и другим компаниям услуг.
                                              

                                              Для подтверждения через API отправьте следующий запрос:
                                              

                                              

                                              ПОЧТА /<WHATSAPP_BUSINESS_ACCOUNT_ID> ?is_enabled_for_insights=true
                                              

                                              После подтверждения мы начнем сбор аналитики шаблонов для бизнес-аккаунта WhatsApp. После подтверждения аналитику шаблонов отключить нельзя.
                                              

                                              В случае успешного выполнения API отправит вам идентификатор вашего бизнес-аккаунта WhatsApp. Например:
                                              

                                              

                                              { "id": 102290129340398 }
                                              

                                              

                                              

                                              

                                              Параметры анализа шаблонов
                                              

                                              

                                              



Имя 

Описание 

Пример значения 




                                              

                                              начинать
                                              

                                              Строка времени или даты в формате UNIX
                                              


                                              

                                              Необходимый.
                                              

                                              Начальное время для диапазона дат, за который вы получаете аналитические данные. Может быть представлено либо в виде целочисленной метки времени Unix, либо в виде строки даты в формате ГГГГ-ММ-ДД. Поскольку шаблонные аналитические данные предоставляются с ежедневной детализацией в часовом поясе UTC, начальная метка времени Unix, не соответствующая 0:00 UTC, будет скорректирована до текущего времени день'день'00:00 UTC.
                                              

                                              Если use_waba_timezone имеет значение true, это значение должно быть строкой даты в формате ГГГГ-ММ-ДД.
                                              


                                              

                                              1543536000
                                              



                                              

                                              конец
                                              

                                              Строка времени или даты в формате UNIX
                                              


                                              

                                              Необходимый.
                                              

                                              Время окончания диапазона дат, за который вы получаете аналитические данные. Может быть представлено либо в виде целочисленной метки времени Unix, либо в виде строки даты в формате ГГГГ-ММ-ДД. Поскольку аналитические данные шаблона предоставляются с ежедневной детализацией в часовом поясе UTC, метка времени окончания Unix, не соответствующая 0:00 UTC, будет скорректирована до текущего времени день'день'00:00 UTC.
                                              

                                              Если use_waba_timezone имеет значение true, это значение должно быть строкой даты в формате ГГГГ-ММ-ДД.
                                              


                                              

                                              1543708800
                                              



                                              

                                              детализация
                                              

                                              Перечисление
                                              


                                              

                                              Необходимый.
                                              

                                              Уровень детализации, с которым вы хотите получать аналитические данные. Значение должно быть ЕЖЕДНЕВНЫМ.
                                              


                                              

                                              ЕЖЕДНЕВНО
                                              



                                              

                                              template_ids
                                              

                                              Массив идентификаторов
                                              


                                              

                                              Необходимый.
                                              

                                              Массив идентификаторов шаблонов, для которых вы хотите получить аналитические данные.
                                              

                                              Максимум 10.
                                              


                                              

                                              [1924084211297547,954638012257287,969725530748535]
                                              



                                              

                                              metric_types
                                              

                                              Массив перечислений
                                              


                                              

                                              Необязательный.
                                              

                                              Типы метрик, которые вы хотите получить. Если этот параметр отсутствует или представляет собой пустой массив, будут возвращены аналитические данные для всех типов метрик.
                                              

                                              Возможные значения:
                                              

                                                РАСХОДЫНАЖАЛДОСТАВЛЕННЫЙЧИТАТЬОТПРАВИЛAPP_ACTIVATIONS (MM API только для WhatsApp)APP_ADD_TO_CART (MM API только для WhatsApp)APP_CHECKOUTS_INITIATED (MM API только для WhatsApp)APP_PURCHASES (MM API только для WhatsApp)APP_PURCHASES_CONVERSION_VALUE (только для API MM для WhatsApp)WEBSITE_ADD_TO_CART (MM API только для WhatsApp)WEBSITE_CHECKOUT_INITIATED (MM API только для WhatsApp)ПОКУПКИ НА САЙТЕ (MM API только для WhatsApp)WEBSITE_PURCHASES_CONVERSION_VALUE (MM API только для WhatsApp)


                                                Обратите внимание, что РАСХОДЫ Возврат средств за WABA, использующие одно и то же решение, не предусмотрен ПартнерПартнеркредитная линия. Если ваш WABA предоставляет решение ПартнерПартнерДля уточнения информации о кредитной линии обратитесь к своему партнеру по решениям.
                                                


                                                

                                                [ОТПРАВЛЕНО, ДОСТАВЛЕНО, ПРОЧИТАНО]
                                                



                                                

                                                тип продукта
                                                

                                                Перечисление
                                                


                                                

                                                Необязательный.
                                                

                                                Тип продукта метрик, которые вы хотите получить. Если этот параметр опущен, будут возвращены только аналитические данные для Cloud API.
                                                

                                                Возможные значения:
                                                

                                                  CLOUD_API: Используйте этот тип продукта для фильтрации метрик шаблонов, отправляемых через Cloud API.MARKETING_MESSAGES_API_FOR_WHATSAPP: Используйте этот тип продукта для фильтрации метрик шаблонов, отправляемых через Marketing Messages API для WhatsApp.
                                                  


                                                  

                                                  API для маркетинговых сообщений WhatsApp
                                                  



                                                  

                                                  <USE_WABA_TIMEZONE>
                                                  

                                                  Логический
                                                  


                                                  

                                                  Необязательный.
                                                  

                                                  Показывать ли метрики в ВАБАВАБАУказан заданный часовой пояс. Если значение равно false или отсутствует, показатели будут отображаться в формате UTC.
                                                  

                                                  Если значение равно true, параметры start и end должны быть в формате ГГГГ-ММ-ДД.
                                                  


                                                  

                                                  истинный
                                                  

                                                  

                                                  

                                                  Примеры
                                                  Получающий
аналитика всех шаблонов
                                                  Сценарий: Задан 1-дневный период. Необходимо получить все типы метрик аналитики шаблонов для шаблона аутентификации и маркетингового шаблона с кнопкой URL.
                                                  Пример запроса:
                                                  curl -g 'https://graph.facebook.com/v25.0/109259195336416/template_analytics?start=1718064000&end=1718122745&granularity=daily&metric_types=cost%2Cclicked%2Cdelivered%2Cread%2Csent&template_ids=[1421988012088524%2C2632273056924580]' \ -H 'Авторизация: Bearer EAAJB...'

                                                  Пример ответа:
                                                  { "data": [ { "granularity": "DAILY", "product_type": "cloud_api", // Доступно только для компаний в альфа-версии API маркетинговых сообщений для WhatsApp "data_points": [ { "template_id": "1421988012088524", "start": 1718064000, "end": 1718150400, "sent": 1, "delivered": 1, "read": 1, "cost": [ { "type": "amount_spent", "value": 0.01 }, { "type": "cost_per_delivered", "value": 0.01 } ] }, { "template_id": "2632273056924580", "start": 1718064000, "end": 1718150400, "sent": 1, "доставлено": 1, "прочитано": 1, "нажато": [ { "тип": "кнопка быстрого ответа", "содержимое кнопки": "Связаться со службой поддержки", "количество": 108 }, { "тип": "уникальная кнопка URL", "содержимое кнопки": "Расскажите подробнее", "количество": 16 } ], "стоимость": [ { "тип": "израсходованная сумма", "значение": 0.03 }, { "тип": "стоимость за доставленный", "значение": 0.03 }, { "тип": "стоимость за клик по кнопке URL", "значение": 0.03 } ] } ] } ], "пагинация": { "курсоры": { "до": "MAZDZD", "после": "MjQZD" } } }
                                                  Аналитика шаблонов: стоимость и показатели кликов
                                                  

                                                  Показатели затрат возвращаются в виде массива объектов затрат, каждый из которых имеет тип и значение. Типы могут быть следующими:
                                                  

                                                    сумма_потрачено —- Общая сумма, потраченная на открытые в рамках диалогов начинать и конец Сроки, указанные в результате отправки шаблона. См Начало разговоров.стоимость_за_доставку —- Он сумма_потрачено значение, деленное на количество раз, когда шаблон был доставлен в течение начинать и конец временные рамки.стоимость_за_клик_кнопки_по_адресу_ссылке —- Он сумма_потрачено значение, деленное на количество раз, когда шаблон'шаблон'Кнопка URL была нажата внутри начинать и конец Временные рамки. Нажатия кнопки быстрого ответа не учитываются. Объект опускается, если шаблон не содержит кнопки URL.

                                                    Показатели кликов возвращаются в виде массива объектов JSON, каждый из которых содержит тип и значение. Клики возвращаются только для кнопок URL и кнопок быстрого ответа в шаблонах, отнесенных к категориям МАРКЕТИНГ или ПОЛЕЗНОСТЬ.
                                                    

                                                    Типы могут быть следующими:
                                                    

                                                      url_button —- Общее количество кликов по кнопке в URL-адресе.unique_url_button —- Показатель уникальных кликов отслеживает количество различных учетных записей WhatsApp, которые нажали на кнопку. Этот показатель помогает понять, сколько отдельных пользователей взаимодействуют с вашими призывами к действию, исключая повторные клики от одного и того же получателя и обеспечивая точное измерение вовлеченности.

                                                      

                                                      

                                                      

                                                      Отключение аналитики кликов по кнопкам
                                                      

                                                      Вы можете отключить отслеживание нажатий кнопок для отдельного шаблона, задав для него соответствующие параметры cta_url_link_tracking_opted_out поле к истинныйПосле отключения API больше не будет возвращать свойство clicked в аналитике шаблонов и не будет отображать активность/клики по кнопкам в WhatsApp Manager при просмотре шаблон'шаблон'идеи.
                                                      

                                                      

                                                      

                                                      Запрос
синтаксис
                                                      ПОЧТА /<TEMPLATE_ID> ?cta_url_link_tracking_opted_out=<OPT_OUT> &category=<TEMPLATE_CATEGORY>
                                                      Параметры запроса
                                                      

                                                      

                                                      



Заполнитель 

Описание 

Пример значения 




                                                      

                                                      <WHATSAPP_TEMPLATE_ID>
                                                      

                                                      Идентификатор шаблона
                                                      


                                                      

                                                      Необходимый.
                                                      

                                                      Идентификатор шаблона.
                                                      


                                                      

                                                      245435364965041
                                                      



                                                      

                                                      <OPT_OUT>
                                                      

                                                      Логический
                                                      


                                                      

                                                      Необходимый.
                                                      

                                                      Указывает, отключено ли отслеживание кликов по кнопкам шаблона. Установите значение true , чтобы отключить отслеживание кликов по кнопкам в шаблоне, или false, чтобы включить.
                                                      

                                                      это значение устанавливается в false При создании шаблона
                                                      


                                                      

                                                      истинный
                                                      



                                                      

                                                      <TEMPLATE_CATEGORY>
                                                      

                                                      Нить
                                                      


                                                      

                                                      Необходимый.
                                                      

                                                      Шаблон'Шаблон'текущая категория.
                                                      

                                                      Если вы зададите категории шаблона значение, отличное от текущей категории, статус шаблона изменится на «ОЖИДАЕТСЯ» , и шаблон должен пройти проверку для утверждения.
                                                      


                                                      

                                                      маркетинг
                                                      

                                                      

                                                      

                                                      Пример
запрос
                                                      curl -X POST 'https://graph.facebook.com/v25.0/245435364965041?cta_url_link_tracking_opted_out=true&category=marketing' \ -H 'Авторизация: Bearer EAAJB...'

                                                      Пример ответа
                                                      В случае успеха API ответит следующим образом:
                                                      { "success": true }
                                                      Аналитика групп шаблонов
                                                      

                                                      Поле template_group_analytics позволяет получить количество отправленных, доставленных и прочитанных шаблонов в группе шаблонов , а также количество нажатий на кнопки URL или кнопки быстрого ответа .
                                                      

                                                      Данные возвращаются с точностью до дня в часовом поясе UTC по умолчанию ВАБАВАБАчасовой пояс, с периодом ретроспективного анализа до 90 дней. Для отображения данных в ВАБАВАБАДля заданного часового пояса передайте параметр use_waba_timezone со значением true.
                                                      

                                                      

                                                      {
                                                      
"данные":
                                                      
[
                                                      
{
                                                      
"waba_timezone": "America/Los_Angeles", "granularity": "DAILY", "product_type": "cloud_api", "data_points": [ ... ] } }
                                                      Ограничения
                                                      

                                                      Аналитика кликов по кнопкам доступна только для шаблонов, отнесенных к категориям «маркетинг» или «полезные». WABA-аккаунты, принадлежащие или используемые совместно с Meta Business Accounts в Европейском Союзе, Великобритании или Японии, или имеющие бизнес-номер телефона с кодом страны из этих стран или регионов, не поддерживаются.
                                                      

                                                      

                                                      

                                                      

                                                      Включение аналитики шаблонов
                                                      

                                                      Для получения аналитики по группам с использованием шаблонов необходимо включить аналитику по шаблонам в вашем аккаунте WhatsApp Business. Подтвердить включение аналитики по шаблонам можно с помощью WhatsApp Manager или API.
                                                      

                                                      

                                                      Подтвердив доступ через API, вы даёте Meta разрешение на добавление аналитических данных в ваш бизнес-аккаунт WhatsApp. Эти данные включают отслеживание ссылок для составления отчётов о переходах на веб-сайты. Вы можете отключить отслеживание ссылок в каждом шаблоне сообщения. Вы также даёте Meta разрешение на сбор и анонимизацию данных из ваших чатов с клиентами. Meta будет анонимизировать эти данные для улучшения предоставляемых вам и другим компаниям услуг.
                                                      

                                                      Для подтверждения включения через API отправьте следующий запрос:
                                                      

                                                      ПОЧТА /<WHATSAPP_BUSINESS_ACCOUNT_ID> ?is_enabled_for_insights=true
                                                      

                                                      В случае успеха API отправит вам идентификатор вашей бизнес-учетной записи WhatsApp, и мы начнем сбор аналитики по группам шаблонов для этой бизнес-учетной записи WhatsApp.
                                                      

                                                      После включения аналитику шаблонов отключить ее невозможно.
                                                      

                                                      

                                                      

                                                      Запрос
синтаксис
                                                      ПОЛУЧАТЬ /<WHATSAPP_BUSINESS_ACCOUNT_ID> /template_group_analytics ?granularity=daily &start=<START_TIME> &end=<END_TIME> &metric_types=<METRIC_TYPES> &template_group_ids=[<TEMPLATE_GROUP_IDS> ]
                                                      Параметры аналитики групп шаблонов
                                                      

                                                      

                                                      



Заполнитель 

Описание 

Пример значения 




                                                      

                                                      <WABA_ID>Нить
                                                      


                                                      

                                                      Необходимый.
                                                      

                                                      Идентификатор бизнес-аккаунта WhatsApp.
                                                      


                                                      

                                                      102290129340398
                                                      



                                                      

                                                      <START_TIME>
                                                      

                                                      Строка времени или даты в формате UNIX
                                                      


                                                      

                                                      Необходимый.
                                                      

                                                      Время начала диапазона дат, за который вы получаете аналитические данные. Может быть представлено либо в виде целочисленной метки времени Unix, либо в виде строки даты в формате ГГГГ-ММ-ДД.
                                                      

                                                      Поскольку аналитика групп шаблонов предоставляется с ежедневной детализацией в часовом поясе UTC, начальная метка времени Unix, не соответствующая 0:00 UTC, будет скорректирована до текущего значения день'день'00:00 UTC.
                                                      

                                                      Если use_waba_timezone имеет значение true, это значение должно быть строкой даты в формате ГГГГ-ММ-ДД.
                                                      


                                                      

                                                      1738465116
                                                      



                                                      

                                                      <END_TIME>
                                                      

                                                      Строка времени или даты в формате UNIX
                                                      


                                                      

                                                      Необходимый.
                                                      

                                                      Время окончания диапазона дат, за который вы получаете аналитические данные. Может быть представлено либо в виде целочисленной метки времени Unix, либо в виде строки даты в формате ГГГГ-ММ-ДД.
                                                      

                                                      Поскольку аналитика групп шаблонов предоставляется с ежедневной детализацией в часовом поясе UTC, конечная метка времени Unix, не соответствующая 0:00 UTC, будет скорректирована до текущего значения день'день'00:00 UTC.
                                                      

                                                      Если параметр use_waba_timezone имеет значение true, это значение должно быть строкой даты в формате ГГГГ-ММ-ДД.
                                                      


                                                      

                                                      1739559516
                                                      



                                                      

                                                      <METRIC_TYPES>
                                                      

                                                      Массив строк
                                                      


                                                      

                                                      Необязательный.
                                                      

                                                      Массив метрик, которые вы хотите получить. Если вы отправите пустой массив, API вернет результаты для всех типов метрик.
                                                      

                                                      Возможные значения:
                                                      

                                                        расходыкликнулдоставленныйчитатьотправил

                                                        Обратите внимание, что функция COST недоступна для корпоративных клиентов, счета за услуги которых выставляются через партнера по решениям.
                                                        

                                                        


                                                        

                                                        [отправлено, доставлено, прочитано]

                                                        



                                                        

                                                        <TEMPLATE_GROUP_IDS>
                                                        


                                                        

                                                        Необходимый.
                                                        

                                                        Массив идентификаторов групп шаблонов, для которых вы хотите получить метрики групп шаблонов.
                                                        

                                                        Максимум 10 идентификаторов.
                                                        


                                                        

                                                        102290129340398
                                                        



                                                        

                                                        <USE_WABA_TIMEZONE>`
                                                        

                                                        Логический
                                                        


                                                        

                                                        Необязательный.
                                                        

                                                        Показывать ли метрики в ВАБАВАБАУказан заданный часовой пояс. Если значение равно false или отсутствует, показатели будут отображаться в формате UTC.
                                                        

                                                        Если значение равно true, параметры start и end должны быть в формате ГГГГ-ММ-ДД.
                                                        


                                                        

                                                        истинный
                                                        

                                                        

                                                        

                                                        Пример
запрос
                                                        curl -g 'https://graph.facebook.com/v25.0/102290129340398/template_group_analytics?granularity=daily&start=1738465116&end=1739559516&metric_types=sent,delivered,read&template_group_ids=[1044106240855852]' \ -H 'Авторизация: Bearer EAAJB...'

                                                        Пример ответа
                                                        Обратите внимание, что приведенный ниже пример сокращен многоточием (...) для краткости.
                                                        { "data": [ { "granularity": "DAILY", "data_points": [ { "template_group_id": "1044106240855852", "start": 1739491200, "end": 1739577600, "sent": 1460, "delivered": 1460, "read": 1399 }, { "template_group_id": "1044106240855852", "start": 1739404800, "end": 1739491200, "sent": 673, "delivered": 673, "read": 645 }, ... ] } ], "paging": { "cursors": { "before": "MAZDZD", "after": "MjQZD" } } }
                                                        Показатели стоимости и кликов для групп шаблонов
                                                        

                                                        Показатели затрат возвращаются в виде массива объектов затрат, каждый из которых имеет тип и значение. Типы могут быть следующими:
                                                        

                                                          сумма_потрачено —- Общая сумма, потраченная на открытые в рамках диалогов начинать и конец Сроки, указанные в результате отправки шаблона. См Начало разговоров.стоимость_за_доставку —- Он сумма_потрачено значение, деленное на количество раз, когда шаблон был доставлен в течение начинать и конец временные рамки.стоимость_за_клик_кнопки_по_адресу_ссылке —- Он сумма_потрачено значение, деленное на количество раз, когда шаблон'шаблон'Кнопка URL была нажата внутри начинать и конец Временные рамки. Нажатия кнопки быстрого ответа не учитываются. Объект опускается, если шаблон не содержит кнопки URL.

                                                          Показатели кликов возвращаются в виде массива объектов JSON, каждый из которых содержит тип и значение. Клики возвращаются только для кнопок URL и кнопок быстрого ответа в шаблонах, отнесенных к категориям «маркетинг» или «полезные материалы».
                                                          

                                                          Типы могут быть следующими:
                                                          

                                                            url_button —- Общее количество кликов по кнопке в URL-адресе.unique_url_button —- Показатель уникальных кликов отслеживает количество различных учетных записей WhatsApp, которые нажали на кнопку. Этот показатель помогает понять, сколько отдельных пользователей взаимодействуют с вашими призывами к действию, исключая повторные клики от одного и того же получателя и обеспечивая точное измерение вовлеченности.
                                                            Анализ звонков
                                                            Он call_analytics В этом поле указывается количество и тип звонков, совершенных и принятых по телефонным номерам, связанным с конкретной сетью WABA. При совершении звонка /<WHATSAPP_BUSINESS_ACCOUNT_ID> ?fields=call_analytics.{filtering-parameters}Вы можете добавить следующие параметры.
                                                            Параметры анализа звонков
                                                            
Имя

Описание

Пример значения

                                                            начинать
                                                            тип: метка времени UNIX
                                                            Необходимый.
                                                            Начальная дата для диапазона дат, за который вы получаете аналитические данные.
                                                            1728581152
                                                            конец
                                                            тип: метка времени UNIX
                                                            Необходимый.
                                                            Конечная дата для диапазона дат, за который вы получаете аналитические данные.
                                                            1728581152
                                                            детализация
                                                            тип: Строка
                                                            Необходимый.
                                                            Уровень детализации, с которым вы хотите получать аналитические данные. Поддерживаемые параметры:
                                                              ПОЛЧАСАЕЖЕДНЕВНОЕЖЕМЕСЯЧНО
                                                              ЕЖЕДНЕВНО
                                                              номера телефонов
                                                              тип: Массив
                                                              Необязательный.
                                                              Массив телефонных номеров, для которых вы хотите получить аналитические данные. Если не указан, будут включены все телефонные номера, добавленные в ваш WABA-архив.
                                                              [15550783881,15550783882]
                                                              коды стран
                                                              тип: Массив
                                                              Необязательный.
                                                              Укажите страны, для которых вы хотите получить аналитические данные. Предоставьте массив с двухбуквенными кодами стран, которые вы хотите включить. Если данные не указаны, будут возвращены аналитические данные для всех стран, с которыми вы взаимодействовали.
                                                              [США, Бразилия]
                                                              указания
                                                              Массив перечислений
                                                              Необязательный.
                                                              Направление звонка, для которого вы хотите получить аналитические данные. Поддерживаемые параметры:
                                                                ИНИЦИИРОВАННЫЙ ПОЛЬЗОВАТЕЛЕМИНИЦИИРОВАННЫЙ БИЗНЕС
                                                                ИНИЦИИРОВАННЫЙ ПОЛЬЗОВАТЕЛЕМ
                                                                размеры
                                                                Массив перечислений
                                                                Необязательный.
                                                                Список вариантов разбивки, которые вы хотите применить к своим метрикам. Если вы отправите пустой список, мы вернем результаты без каких-либо вариантов разбивки. Поддерживаемые параметры:
                                                                  телефоннаправлениестрана
                                                                  направление
                                                                  metric_types
                                                                  Массив перечислений
                                                                  Необязательный.
                                                                  Массив метрик, которые вы хотите получить. Если вы отправите пустой массив, API вернет результаты для всех типов метрик. Поддерживаемые параметры:
                                                                    СЧИТАТЬРАСХОДЫСРЕДНЯЯ_ПРОДОЛЖИТЕЛЬНОСТЬ
                                                                    СРЕДНЯЯ_ПРОДОЛЖИТЕЛЬНОСТЬ
                                                                    Пример
                                                                    Сценарий: Вам необходимо получить количество инициированных пользователями звонков, поступивших на все телефонные номера, связанные с вашей системой WABA, с точностью до дня.
                                                                    Предложенное решение: Используйте следующие параметры фильтрации: начинать, конец, детализация, указания.
                                                                    curl -i -X ​​GET "https://graph.facebook.com/v25.0/102290129340398 ?fields=call_analytics .start(1759302000) .end(1767168000) .granularity(DAILY) .directions(USER_INITIATED) &access_token=BLI8lkj..."

                                                                    Успешный ответ возвращает call_analytics объект с запрошенными вами данными:
                                                                    { "call_analytics": { "granularity": "DAILY", "directions": "USER_INITIATED", "data_points": [ { "start": 1765958400, "end": 1766044800, "cost": 0.47795, "count": 35, "average_duration": 106 }, { "start": 1760943600, "end": 1761030000, "cost": 0, "count": 20, "average_duration": 103 }, { "start": 1760857200, "end": 1760943600, "cost": 0, "count": 24, "average_duration": 103 }, # more data points ] }, "id": "102290129340398" }
                                                                    Групповая аналитика
                                                                    API групповой аналитики позволяет получать информацию о количестве отправленных, доставленных и прочитанных сообщений в группах WhatsApp, а также о количестве участников, присоединившихся к группе или покинувших её.
                                                                    Данные предоставляются с ежедневной детализацией и периодом анализа до 90 дней.
                                                                    Синтаксис запроса
                                                                    ПОЛУЧАТЬ /<WHATSAPP_BUSINESS_ACCOUNT_ID> /group_analytics ?granularity=daily &start=<START_TIME> &end=<END_TIME> &metric_types=[<METRIC_TYPES> ] &group_ids=[<GROUP_IDS> ]
                                                                    Параметры групповой аналитики
                                                                    
Заполнитель

Описание

Пример значения

                                                                    <START_TIME>
                                                                    Временная метка UNIX
                                                                    Необходимый.
                                                                    Начальное время для диапазона дат, за который вы получаете аналитические данные. Оно не должно превышать 90 дней от текущей даты.
                                                                    1685548801
                                                                    <END_TIME>
                                                                    Временная метка UNIX
                                                                    Необходимый.
                                                                    Время окончания периода, за который вы получаете аналитические данные.
                                                                    1685721600
                                                                    <GROUP_IDS>
                                                                    Массив строк
                                                                    Необходимый.
                                                                    Массив идентификаторов групп, для которых вы хотите получить групповые метрики.
                                                                    В настоящее время поддерживается только 1 идентификатор.
                                                                    ["GROUP_ID"]
                                                                    <GRANULARITY>
                                                                    Нить
                                                                    Необязательный.
                                                                    Уровень детализации, с которым вы хотели бы получать аналитические данные.
                                                                    Возможные значения:
                                                                      ЕЖЕДНЕВНО
                                                                      По умолчанию: ЕЖЕДНЕВНО.
                                                                      ЕЖЕДНЕВНО
                                                                      <METRIC_TYPES>
                                                                      Массив строк
                                                                      Необходимый.
                                                                      Набор метрик, которые вы хотели бы получать.
                                                                      Возможные значения:
                                                                        ОТПРАВИЛ — Количество сообщений, отправленных компанией в группу.ДОСТАВЛЕННЫЙ — Количество раз, когда сообщение было доставлено участнику группы.ЧИТАТЬ — Количество прочтений сообщения участником группы.УЧАСТНИКИ_ПРИСОЕДИНИЛИСЬ — Количество раз, когда участник присоединялся к группе.УЧАСТНИКИ_ЛЕВЫЕ — Количество раз, когда участник покидал группу.
                                                                        ["ОТПРАВЛЕНО","ПРОЧИТАНО","ПРИСОЕДИНЯЮЩИЕСЯ УЧАСТНИКИ"]
                                                                        Пример запроса
                                                                        curl -g 'https://graph.facebook.com/v25.0/102290129340398/group_analytics?start=1764662400&end=1764921600&granularity=DAILY&group_ids=['GROUP_ID']&metric_types=['SENT','DELIVERED', 'READ','PARTICIPANTS_JOINED','PARTICIPANTS_LEFT']' \ -H 'Авторизация: Bearer EAAJB...'

                                                                        Пример ответа
                                                                        Обратите внимание, что приведенный ниже пример сокращен многоточием (...) для краткости.
                                                                        { "данные": [ { "гранулярность": "ежедневно", "точки данных": [ { "идентификатор группы": "идентификатор группы", "начало": 1685548801, "конец": 1685635200, "отправлено": 100, "доставлено": 250, "прочитано": 200, "присоединилось": 3, "слева": 1 }, { "идентификатор группы": "идентификатор группы", "начало": 1685635201, "конец": 1685721600, "отправлено": 80, "доставлено": 200, "прочитано": 150, "присоединилось": 1, "слева": 0 }, ... ] } ], "пагинация": { "курсоры": { "до": "MAZDZD", "после": "MjQZD" } } }
                                                                        Ссылка
                                                                        Список всех возможных значений для каждого поля см. в справочнике Graph API Поле «Аналитика бизнес-аккаунта WhatsApp».
                                                                        
    
                                                                                
                                                                        
    
                                                                        

            
                                                                        
        
                                                                        
    
                                                                        

    
                                                                        

    
    
                                                                        
        
                                                                        
             Вернуться наверх