whatsapp-docs-mcp 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +22 -0
- package/README.md +181 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +65 -0
- package/dist/index.js.map +1 -0
- package/dist/prompts.d.ts +22 -0
- package/dist/prompts.d.ts.map +1 -0
- package/dist/prompts.js +305 -0
- package/dist/prompts.js.map +1 -0
- package/dist/resources.d.ts +24 -0
- package/dist/resources.d.ts.map +1 -0
- package/dist/resources.js +132 -0
- package/dist/resources.js.map +1 -0
- package/dist/tools.d.ts +6 -0
- package/dist/tools.d.ts.map +1 -0
- package/dist/tools.js +379 -0
- package/dist/tools.js.map +1 -0
- package/dist/utils/fileLoader.d.ts +19 -0
- package/dist/utils/fileLoader.d.ts.map +1 -0
- package/dist/utils/fileLoader.js +126 -0
- package/dist/utils/fileLoader.js.map +1 -0
- package/dist/utils/search.d.ts +27 -0
- package/dist/utils/search.d.ts.map +1 -0
- package/dist/utils/search.js +91 -0
- package/dist/utils/search.js.map +1 -0
- package/docs/QUICK_REFERENCE.md +223 -0
- package/docs/anuncios_com_clique_para_whatsapp/AGENTS.md +8 -0
- package/docs/anuncios_com_clique_para_whatsapp/welcome_message_sequences.md +449 -0
- package/docs/ativos_da_conta/AGENTS.md +9 -0
- package/docs/ativos_da_conta/outros_ativos/AGENTS.md +12 -0
- package/docs/ativos_da_conta/outros_ativos/business_profiles.md +137 -0
- package/docs/ativos_da_conta/outros_ativos/display_names.md +108 -0
- package/docs/ativos_da_conta/outros_ativos/official_business_accounts.md +123 -0
- package/docs/ativos_da_conta/outros_ativos/qr_codes.md +198 -0
- package/docs/ativos_da_conta/outros_ativos/whatsapp_business_accounts.md +99 -0
- package/docs/ativos_da_conta/telefones_comerciais/AGENTS.md +11 -0
- package/docs/ativos_da_conta/telefones_comerciais/conversational_components.md +347 -0
- package/docs/ativos_da_conta/telefones_comerciais/phone_numbers.md +486 -0
- package/docs/ativos_da_conta/telefones_comerciais/registration.md +171 -0
- package/docs/ativos_da_conta/telefones_comerciais/two_step_verification.md +66 -0
- package/docs/catalogos/AGENTS.md +12 -0
- package/docs/catalogos/receive_responses.md +28 -0
- package/docs/catalogos/sell_products_and_services.md +24 -0
- package/docs/catalogos/set_commerce_settings.md +163 -0
- package/docs/catalogos/share_products.md +401 -0
- package/docs/catalogos/upload_inventory.md +28 -0
- package/docs/comecar/AGENTS.md +8 -0
- package/docs/comecar/get_started.md +127 -0
- package/docs/dados_privacidade_e_politica/AGENTS.md +16 -0
- package/docs/dados_privacidade_e_politica/block_users.md +549 -0
- package/docs/dados_privacidade_e_politica/data_privacy_and_security.md +78 -0
- package/docs/dados_privacidade_e_politica/encryption.md +8 -0
- package/docs/dados_privacidade_e_politica/getting_opt_in.md +41 -0
- package/docs/dados_privacidade_e_politica/identity_change.md +34 -0
- package/docs/dados_privacidade_e_politica/local_storage.md +277 -0
- package/docs/dados_privacidade_e_politica/no_storage.md +132 -0
- package/docs/dados_privacidade_e_politica/policy_enforcement.md +85 -0
- package/docs/dados_privacidade_e_politica/policy_enforcement_violations.md +127 -0
- package/docs/grupos/AGENTS.md +15 -0
- package/docs/grupos/error_codes.md +170 -0
- package/docs/grupos/faq.md +30 -0
- package/docs/grupos/get_started.md +73 -0
- package/docs/grupos/groups.md +75 -0
- package/docs/grupos/groups_messaging.md +340 -0
- package/docs/grupos/pricing.md +322 -0
- package/docs/grupos/reference.md +1059 -0
- package/docs/grupos/webhooks.md +298 -0
- package/docs/index.md +318 -0
- package/docs/insights/AGENTS.md +8 -0
- package/docs/insights/analytics.md +944 -0
- package/docs/ligacoes/AGENTS.md +20 -0
- package/docs/ligacoes/app_review_guidelines.md +48 -0
- package/docs/ligacoes/business_initiated_calls.md +858 -0
- package/docs/ligacoes/call_button_messages_deep_links.md +454 -0
- package/docs/ligacoes/call_settings.md +643 -0
- package/docs/ligacoes/calling.md +130 -0
- package/docs/ligacoes/faq.md +468 -0
- package/docs/ligacoes/integration_patterns.md +121 -0
- package/docs/ligacoes/pricing.md +339 -0
- package/docs/ligacoes/reference.md +1923 -0
- package/docs/ligacoes/sip.md +1090 -0
- package/docs/ligacoes/troubleshooting.md +483 -0
- package/docs/ligacoes/user_call_permissions.md +672 -0
- package/docs/ligacoes/user_initiated_calls.md +1030 -0
- package/docs/mensagens/AGENTS.md +46 -0
- package/docs/mensagens/limites_de_mensagens/AGENTS.md +9 -0
- package/docs/mensagens/limites_de_mensagens/messaging_limits.md +91 -0
- package/docs/mensagens/limites_de_mensagens/upcoming_changes.md +8 -0
- package/docs/mensagens/recursos_adicionais/AGENTS.md +13 -0
- package/docs/mensagens/recursos_adicionais/contextual_replies.md +82 -0
- package/docs/mensagens/recursos_adicionais/link_previews.md +58 -0
- package/docs/mensagens/recursos_adicionais/mark_message_as_read.md +111 -0
- package/docs/mensagens/recursos_adicionais/media.md +419 -0
- package/docs/mensagens/recursos_adicionais/payload_encryption.md +8 -0
- package/docs/mensagens/recursos_adicionais/typing_indicators.md +117 -0
- package/docs/mensagens/tipos_de_mensagens/AGENTS.md +24 -0
- package/docs/mensagens/tipos_de_mensagens/address_messages.md +465 -0
- package/docs/mensagens/tipos_de_mensagens/audio_messages.md +211 -0
- package/docs/mensagens/tipos_de_mensagens/contacts_messages.md +482 -0
- package/docs/mensagens/tipos_de_mensagens/document_messages.md +232 -0
- package/docs/mensagens/tipos_de_mensagens/image_messages.md +176 -0
- package/docs/mensagens/tipos_de_mensagens/interactive_cta_url_messages.md +240 -0
- package/docs/mensagens/tipos_de_mensagens/interactive_flow_messages.md +8 -0
- package/docs/mensagens/tipos_de_mensagens/interactive_list_messages.md +300 -0
- package/docs/mensagens/tipos_de_mensagens/interactive_reply_buttons_messages.md +271 -0
- package/docs/mensagens/tipos_de_mensagens/location_messages.md +156 -0
- package/docs/mensagens/tipos_de_mensagens/location_request_messages.md +310 -0
- package/docs/mensagens/tipos_de_mensagens/message_with_link.md +8 -0
- package/docs/mensagens/tipos_de_mensagens/reaction_messages.md +144 -0
- package/docs/mensagens/tipos_de_mensagens/sticker_messages.md +157 -0
- package/docs/mensagens/tipos_de_mensagens/template_messages.md +20 -0
- package/docs/mensagens/tipos_de_mensagens/text_messages.md +142 -0
- package/docs/mensagens/tipos_de_mensagens/video_messages.md +149 -0
- package/docs/mensagens/visao_geral/AGENTS.md +8 -0
- package/docs/mensagens/visao_geral/send_messages.md +370 -0
- package/docs/mensagens_de_marketing/AGENTS.md +10 -0
- package/docs/mensagens_de_marketing/implementacao/AGENTS.md +10 -0
- package/docs/mensagens_de_marketing/implementacao/get_started.md +107 -0
- package/docs/mensagens_de_marketing/implementacao/onboard_business_customers.md +180 -0
- package/docs/mensagens_de_marketing/implementacao/send_marketing_messages.md +260 -0
- package/docs/mensagens_de_marketing/recursos/AGENTS.md +12 -0
- package/docs/mensagens_de_marketing/recursos/automatic_creative_optimization.md +8 -0
- package/docs/mensagens_de_marketing/recursos/conversion_measurement.md +8 -0
- package/docs/mensagens_de_marketing/recursos/deep_links.md +302 -0
- package/docs/mensagens_de_marketing/recursos/track_click_events.md +119 -0
- package/docs/mensagens_de_marketing/recursos/view_metrics.md +338 -0
- package/docs/mensagens_de_marketing/visao_geral/AGENTS.md +8 -0
- package/docs/mensagens_de_marketing/visao_geral/overview.md +26 -0
- package/docs/modelos/AGENTS.md +12 -0
- package/docs/modelos/gerenciamento_de_modelos/AGENTS.md +21 -0
- package/docs/modelos/gerenciamento_de_modelos/components.md +717 -0
- package/docs/modelos/gerenciamento_de_modelos/supported_languages.md +462 -0
- package/docs/modelos/gerenciamento_de_modelos/tap_target_url_title_override.md +211 -0
- package/docs/modelos/gerenciamento_de_modelos/template_categorization.md +499 -0
- package/docs/modelos/gerenciamento_de_modelos/template_comparison.md +136 -0
- package/docs/modelos/gerenciamento_de_modelos/template_library.md +526 -0
- package/docs/modelos/gerenciamento_de_modelos/template_management.md +148 -0
- package/docs/modelos/gerenciamento_de_modelos/template_media.md +8 -0
- package/docs/modelos/gerenciamento_de_modelos/template_migration.md +164 -0
- package/docs/modelos/gerenciamento_de_modelos/template_pacing.md +38 -0
- package/docs/modelos/gerenciamento_de_modelos/template_pausing.md +58 -0
- package/docs/modelos/gerenciamento_de_modelos/template_quality.md +47 -0
- package/docs/modelos/gerenciamento_de_modelos/template_review.md +74 -0
- package/docs/modelos/gerenciamento_de_modelos/time_to_live.md +88 -0
- package/docs/modelos/modelos_de_autenticacao/AGENTS.md +13 -0
- package/docs/modelos/modelos_de_autenticacao/authentication_best_practices.md +73 -0
- package/docs/modelos/modelos_de_autenticacao/authentication_templates.md +252 -0
- package/docs/modelos/modelos_de_autenticacao/autofill_button_authentication_templates.md +732 -0
- package/docs/modelos/modelos_de_autenticacao/copy_code_button_authentication_templates.md +402 -0
- package/docs/modelos/modelos_de_autenticacao/error_signals.md +143 -0
- package/docs/modelos/modelos_de_autenticacao/zero_tap_authentication_templates.md +742 -0
- package/docs/modelos/modelos_de_marketing/AGENTS.md +18 -0
- package/docs/modelos/modelos_de_marketing/call_permission_request_message_template.md +221 -0
- package/docs/modelos/modelos_de_marketing/catalog_templates.md +308 -0
- package/docs/modelos/modelos_de_marketing/coupon_templates.md +425 -0
- package/docs/modelos/modelos_de_marketing/custom_marketing_templates.md +537 -0
- package/docs/modelos/modelos_de_marketing/limited_time_offer_templates.md +496 -0
- package/docs/modelos/modelos_de_marketing/marketing_templates.md +112 -0
- package/docs/modelos/modelos_de_marketing/media_card_carousel_templates.md +770 -0
- package/docs/modelos/modelos_de_marketing/mpm_templates.md +717 -0
- package/docs/modelos/modelos_de_marketing/per_user_limits.md +42 -0
- package/docs/modelos/modelos_de_marketing/product_card_carousel_templates.md +515 -0
- package/docs/modelos/modelos_de_marketing/spm_templates.md +466 -0
- package/docs/modelos/modelos_de_utilidade/AGENTS.md +8 -0
- package/docs/modelos/modelos_de_utilidade/utility_templates.md +583 -0
- package/docs/modelos/visao_geral/AGENTS.md +8 -0
- package/docs/modelos/visao_geral/overview.md +163 -0
- package/docs/pagamentos/AGENTS.md +9 -0
- package/docs/pagamentos/pagamentos_na_india/AGENTS.md +19 -0
- package/docs/pagamentos/pagamentos_na_india/checkout_button_templates.md +1332 -0
- package/docs/pagamentos/pagamentos_na_india/enhanced_payment_links.md +93 -0
- package/docs/pagamentos/pagamentos_na_india/onboarding_apis.md +580 -0
- package/docs/pagamentos/pagamentos_na_india/orderdetailstemplate.md +205 -0
- package/docs/pagamentos/pagamentos_na_india/orderstatustemplate.md +143 -0
- package/docs/pagamentos/pagamentos_na_india/overview.md +102 -0
- package/docs/pagamentos/pagamentos_na_india/payment_links.md +581 -0
- package/docs/pagamentos/pagamentos_na_india/pg.md +1228 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/AGENTS.md +12 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/dynamic_vpa.md +572 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_billdesk.md +343 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_cashfree.md +145 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_ccavenue.md +146 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/upi_intent.md +660 -0
- package/docs/pagamentos/pagamentos_no_brasil/AGENTS.md +14 -0
- package/docs/pagamentos/pagamentos_no_brasil/boleto.md +104 -0
- package/docs/pagamentos/pagamentos_no_brasil/offsite_pix.md +128 -0
- package/docs/pagamentos/pagamentos_no_brasil/one_click_payments.md +226 -0
- package/docs/pagamentos/pagamentos_no_brasil/orderdetailstemplate.md +180 -0
- package/docs/pagamentos/pagamentos_no_brasil/orders.md +768 -0
- package/docs/pagamentos/pagamentos_no_brasil/overview.md +32 -0
- package/docs/pagamentos/pagamentos_no_brasil/payment_links.md +104 -0
- package/docs/parceiros/AGENTS.md +12 -0
- package/docs/parceiros/analise_do_app/AGENTS.md +8 -0
- package/docs/parceiros/analise_do_app/app_review.md +91 -0
- package/docs/parceiros/gerenciamento/AGENTS.md +14 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/AGENTS.md +15 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_accounts.md +274 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_system_users.md +106 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_webhooks.md +277 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/AGENTS.md +9 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/manage_phone_numbers.md +248 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/registering_phone_numbers.md +373 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/share_and_revoke_credit_lines.md +551 -0
- package/docs/parceiros/gerenciamento/partner_led_business_verification.md +367 -0
- package/docs/parceiros/gerenciamento/pixel_tracking.md +35 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/AGENTS.md +18 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/adding_waba_to_mps.md +64 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/business_customer_support.md +102 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_customers_off_solutions_via_embedded_signup.md +151 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_customers_off_solutions_via_meta_business_suite.md +234 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_phone_numbers_among_solution_partners_programmatically.md +292 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_phone_numbers_among_solution_partners_via_embedded_signup.md +118 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solution_partners_via_embedded_signup.md +76 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solutions_via_embedded_signup.md +90 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solutions_via_meta_business_suite.md +265 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/support.md +48 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/transferring_wabas_to_customers.md +8 -0
- package/docs/parceiros/integracao_de_clientes/AGENTS.md +9 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/AGENTS.md +26 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/app_only_install.md +135 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/automatic_events_api.md +204 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/bypass_phone_addition.md +52 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/custom_flows.md +40 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/default_flow.md +90 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/errors.md +185 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/hosted_es.md +153 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/implementation.md +417 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_business_app_users.md +926 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_customers_as_a_solution_partner.md +402 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_customers_as_a_tech_provider.md +332 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/overview.md +168 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/pre_filled_data.md +524 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/pre_verified_numbers.md +291 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/AGENTS.md +12 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_2_public_preview.md +88 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_3.md +98 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_3_public_preview.md +88 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_4.md +92 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/versions.md +463 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/website_optional.md +57 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/AGENTS.md +11 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_partner_solution_embedded_creation.md +178 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_partner_solutions.md +775 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_solution_conversations.md +319 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/partner_initiated_waba_creation.md +74 -0
- package/docs/parceiros/seja_um_parceiro/AGENTS.md +11 -0
- package/docs/parceiros/seja_um_parceiro/get_started_for_solution_partners.md +280 -0
- package/docs/parceiros/seja_um_parceiro/get_started_for_tech_providers.md +194 -0
- package/docs/parceiros/seja_um_parceiro/measurement_partners.md +146 -0
- package/docs/parceiros/seja_um_parceiro/upgrade_to_tech_partner.md +94 -0
- package/docs/parceiros/visao_geral/AGENTS.md +8 -0
- package/docs/parceiros/visao_geral/overview.md +190 -0
- package/docs/recado/AGENTS.md +9 -0
- package/docs/recado/precos/AGENTS.md +11 -0
- package/docs/recado/precos/pricing.md +915 -0
- package/docs/recado/precos/pricing_authentication_international_rates.md +464 -0
- package/docs/recado/precos/pricing_conversation_based_pricing.md +773 -0
- package/docs/recado/precos/pricing_updates_to_pricing.md +8 -0
- package/docs/recado/sobre_a_plataforma/AGENTS.md +10 -0
- package/docs/recado/sobre_a_plataforma/about_the_platform.md +217 -0
- package/docs/recado/sobre_a_plataforma/access_tokens.md +110 -0
- package/docs/recado/sobre_a_plataforma/permissions.md +55 -0
- package/docs/referencia/AGENTS.md +92 -0
- package/docs/referencia/bot_do_whatsapp_business/AGENTS.md +8 -0
- package/docs/referencia/bot_do_whatsapp_business/bot_details_api.md +762 -0
- package/docs/referencia/business/AGENTS.md +14 -0
- package/docs/referencia/business/add_phone_numbers_api.md +726 -0
- package/docs/referencia/business/client_whatsapp_business_accounts_api.md +1006 -0
- package/docs/referencia/business/owned_whatsapp_business_accounts.md +802 -0
- package/docs/referencia/business/whatsapp_business_accounts_api.md +1550 -0
- package/docs/referencia/business/whatsapp_business_partner_onboarding_to_mm_lite_api.md +783 -0
- package/docs/referencia/business/whatsapp_business_pre_verified_phone_number_sharing_api.md +790 -0
- package/docs/referencia/business/whatsapp_business_pre_verified_phone_numbers_api.md +886 -0
- package/docs/referencia/changelog.md +10 -0
- package/docs/referencia/conta_do_whatsapp_business/AGENTS.md +24 -0
- package/docs/referencia/conta_do_whatsapp_business/assigned_users_management_api.md +2202 -0
- package/docs/referencia/conta_do_whatsapp_business/business_account_api.md +267 -0
- package/docs/referencia/conta_do_whatsapp_business/business_account_extended_credits_api.md +275 -0
- package/docs/referencia/conta_do_whatsapp_business/conversational_automation_api.md +782 -0
- package/docs/referencia/conta_do_whatsapp_business/flows_api.md +1532 -0
- package/docs/referencia/conta_do_whatsapp_business/in_progress_on_behalf_requests_api.md +8 -0
- package/docs/referencia/conta_do_whatsapp_business/migration_intent_api.md +1581 -0
- package/docs/referencia/conta_do_whatsapp_business/obo_mobility_intent_api.md +8 -0
- package/docs/referencia/conta_do_whatsapp_business/phone_number_management_api.md +1686 -0
- package/docs/referencia/conta_do_whatsapp_business/schedules_api.md +1772 -0
- package/docs/referencia/conta_do_whatsapp_business/set_obo_mobility_intent_api.md +8 -0
- package/docs/referencia/conta_do_whatsapp_business/set_solution_migration_intent_api.md +8 -0
- package/docs/referencia/conta_do_whatsapp_business/subscribed_apps_api.md +2178 -0
- package/docs/referencia/conta_do_whatsapp_business/template_api.md +976 -0
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_activities_api.md +842 -0
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_api.md +1384 -0
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_solutions_list_api.md +854 -0
- package/docs/referencia/grupo/AGENTS.md +11 -0
- package/docs/referencia/grupo/groups_invite_link_api.md +304 -0
- package/docs/referencia/grupo/groups_join_requests_api.md +686 -0
- package/docs/referencia/grupo/groups_participants_api.md +274 -0
- package/docs/referencia/grupo/groups_query_api.md +436 -0
- package/docs/referencia/historico_de_mensagens/AGENTS.md +8 -0
- package/docs/referencia/historico_de_mensagens/whatsapp_business_message_history_events_api.md +866 -0
- package/docs/referencia/inscricao/AGENTS.md +10 -0
- package/docs/referencia/inscricao/application_connected_client_businesses.md +812 -0
- package/docs/referencia/inscricao/application_solutions_api.md +874 -0
- package/docs/referencia/inscricao/solution_creation_api.md +824 -0
- package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/AGENTS.md +8 -0
- package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/migration_intent_details_api.md +724 -0
- package/docs/referencia/midias/AGENTS.md +9 -0
- package/docs/referencia/midias/media_api.md +342 -0
- package/docs/referencia/midias/media_download_api.md +160 -0
- package/docs/referencia/numero_da_conta_do_whatsapp/AGENTS.md +8 -0
- package/docs/referencia/numero_da_conta_do_whatsapp/whatsapp_account_number_api.md +778 -0
- package/docs/referencia/perfil_do_whatsapp_business/AGENTS.md +8 -0
- package/docs/referencia/perfil_do_whatsapp_business/whatsapp_business_profile_node_api.md +1494 -0
- package/docs/referencia/solucao_do_whatsapp_business/AGENTS.md +14 -0
- package/docs/referencia/solucao_do_whatsapp_business/accept_deactivation_request_api.md +762 -0
- package/docs/referencia/solucao_do_whatsapp_business/access_token_api.md +704 -0
- package/docs/referencia/solucao_do_whatsapp_business/reject_deactivation_request_api.md +812 -0
- package/docs/referencia/solucao_do_whatsapp_business/send_deactivation_request_api.md +778 -0
- package/docs/referencia/solucao_do_whatsapp_business/solution_accept_api.md +812 -0
- package/docs/referencia/solucao_do_whatsapp_business/solution_details_api.md +768 -0
- package/docs/referencia/solucao_do_whatsapp_business/solution_reject_api.md +798 -0
- package/docs/referencia/telefone_do_whatsapp_business/AGENTS.md +29 -0
- package/docs/referencia/telefone_do_whatsapp_business/block_api.md +542 -0
- package/docs/referencia/telefone_do_whatsapp_business/business_compliance_information_api.md +1608 -0
- package/docs/referencia/telefone_do_whatsapp_business/business_encryption_api.md +1402 -0
- package/docs/referencia/telefone_do_whatsapp_business/calling_api.md +598 -0
- package/docs/referencia/telefone_do_whatsapp_business/encrypted_messages_api.md +482 -0
- package/docs/referencia/telefone_do_whatsapp_business/groups_management_api.md +485 -0
- package/docs/referencia/telefone_do_whatsapp_business/marketing_messages_lite_api.md +315 -0
- package/docs/referencia/telefone_do_whatsapp_business/media_upload_api.md +188 -0
- package/docs/referencia/telefone_do_whatsapp_business/message_api.md +1798 -0
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_api.md +377 -0
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_deregister_api.md +714 -0
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_registration.md +780 -0
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_verification_request_code_api.md +734 -0
- package/docs/referencia/telefone_do_whatsapp_business/register_api.md +411 -0
- package/docs/referencia/telefone_do_whatsapp_business/settings_api.md +674 -0
- package/docs/referencia/telefone_do_whatsapp_business/verify_code_api.md +746 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_message_history_api.md +932 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_official_business_account_status_api.md +1540 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_phone_number_api.md +1600 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_profile_api.md +1478 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_api.md +1179 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_management_api.md +1315 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/AGENTS.md +11 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/request_verification_code_api.md +778 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/verify_code_api.md +768 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_api.md +1382 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_partners_api.md +820 -0
- package/docs/referencia/usuario/AGENTS.md +8 -0
- package/docs/referencia/usuario/assigned_whatsapp_business_accounts_api.md +864 -0
- package/docs/referencia/webhooks/AGENTS.md +8 -0
- package/docs/referencia/webhooks/whatsapp_incoming_webhook_payload.md +1655 -0
- package/docs/suporte/AGENTS.md +13 -0
- package/docs/suporte/api_status_page.md +134 -0
- package/docs/suporte/error_codes.md +1194 -0
- package/docs/suporte/experiments.md +26 -0
- package/docs/suporte/health_status.md +225 -0
- package/docs/suporte/load_testing.md +340 -0
- package/docs/suporte/support.md +408 -0
- package/docs/visao_geral/AGENTS.md +8 -0
- package/docs/visao_geral/overview.md +2590 -0
- package/docs/webhooks/AGENTS.md +41 -0
- package/docs/webhooks/referencia/AGENTS.md +20 -0
- package/docs/webhooks/referencia/account_alerts.md +190 -0
- package/docs/webhooks/referencia/account_review_update.md +90 -0
- package/docs/webhooks/referencia/account_update.md +379 -0
- package/docs/webhooks/referencia/business_capability_update.md +121 -0
- package/docs/webhooks/referencia/history.md +302 -0
- package/docs/webhooks/referencia/message_template_components_update.md +179 -0
- package/docs/webhooks/referencia/message_template_quality_update.md +136 -0
- package/docs/webhooks/referencia/message_template_status_update.md +253 -0
- package/docs/webhooks/referencia/messages/AGENTS.md +24 -0
- package/docs/webhooks/referencia/messages/audio.md +298 -0
- package/docs/webhooks/referencia/messages/button.md +170 -0
- package/docs/webhooks/referencia/messages/contacts.md +491 -0
- package/docs/webhooks/referencia/messages/document.md +307 -0
- package/docs/webhooks/referencia/messages/errors.md +132 -0
- package/docs/webhooks/referencia/messages/image.md +304 -0
- package/docs/webhooks/referencia/messages/interactive.md +225 -0
- package/docs/webhooks/referencia/messages/location.md +296 -0
- package/docs/webhooks/referencia/messages/messages.md +44 -0
- package/docs/webhooks/referencia/messages/order.md +208 -0
- package/docs/webhooks/referencia/messages/reaction.md +178 -0
- package/docs/webhooks/referencia/messages/status.md +364 -0
- package/docs/webhooks/referencia/messages/sticker.md +298 -0
- package/docs/webhooks/referencia/messages/system.md +140 -0
- package/docs/webhooks/referencia/messages/text.md +322 -0
- package/docs/webhooks/referencia/messages/unsupported.md +165 -0
- package/docs/webhooks/referencia/messages/video.md +304 -0
- package/docs/webhooks/referencia/outros_webhooks/AGENTS.md +16 -0
- package/docs/webhooks/referencia/outros_webhooks/partner_solutions.md +114 -0
- package/docs/webhooks/referencia/outros_webhooks/payment_configuration_update.md +135 -0
- package/docs/webhooks/referencia/outros_webhooks/phone_number_name_update.md +129 -0
- package/docs/webhooks/referencia/outros_webhooks/phone_number_quality_update.md +172 -0
- package/docs/webhooks/referencia/outros_webhooks/security.md +108 -0
- package/docs/webhooks/referencia/outros_webhooks/smb_app_state_sync.md +146 -0
- package/docs/webhooks/referencia/outros_webhooks/smb_message_echoes.md +143 -0
- package/docs/webhooks/referencia/outros_webhooks/template_category_update.md +154 -0
- package/docs/webhooks/referencia/outros_webhooks/user_preferences.md +150 -0
- package/docs/webhooks/visao_geral/AGENTS.md +11 -0
- package/docs/webhooks/visao_geral/message_echoes.md +8 -0
- package/docs/webhooks/visao_geral/override.md +235 -0
- package/docs/webhooks/visao_geral/overview.md +158 -0
- package/docs/webhooks/visao_geral/set_up_whatsapp_echo_bot.md +109 -0
- package/package.json +50 -0
|
@@ -0,0 +1,944 @@
|
|
|
1
|
+
<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/analytics -->
|
|
2
|
+
<!-- Scraped: 2025-12-20T17:43:24.987Z -->
|
|
3
|
+
|
|
4
|
+
# Análise
|
|
5
|
+
|
|
6
|
+
Updated: 13 de nov de 2025
|
|
7
|
+
|
|
8
|
+
A partir de 1º de dezembro de 2025, a janela máxima de retrospectiva para análises de mensagens, conversas e preços será alterado de dez para um ano. A janela de retrospectiva para análises de modelos e grupos de modelos não será afetado e continuará sendo de 90 dias.
|
|
9
|
+
|
|
10
|
+
Este documento descreve como consultar análises de mensagens, conversas e modelos. Isso inclui o número de mensagens enviadas de um número de telefone comercial, o número de conversas e os respectivos custos para uma conta comercial do WhatsApp (WABA, pelas iniciais em inglês) ou o número de vezes que determinado modelo foi lido.
|
|
11
|
+
|
|
12
|
+
Somente métricas de números de telefone comerciais e modelos associados à sua WABA no momento da solicitação serão incluídas nas respostas.
|
|
13
|
+
|
|
14
|
+
## Consultar dados
|
|
15
|
+
|
|
16
|
+
Use o ponto de extremidade [GET /<WHATSAPP\_BUSINESS\_ACCOUNT\_ID>](/documentation/business-messaging/whatsapp/reference/whatsapp-business-account/whatsapp-business-account-api#Reading) para consultar análises.
|
|
17
|
+
|
|
18
|
+
### Sintaxe da solicitação
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
curl -g 'https://graph.facebook.com/<API_VERSION>/<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=<FIELD>.<FILTERS>' \
|
|
22
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>'
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Parâmetros de solicitação
|
|
26
|
+
|
|
27
|
+
Espaço reservado
|
|
28
|
+
|
|
29
|
+
Descrição
|
|
30
|
+
|
|
31
|
+
Valor de exemplo
|
|
32
|
+
|
|
33
|
+
`<FIELD>`
|
|
34
|
+
|
|
35
|
+
**Obrigatório.**
|
|
36
|
+
|
|
37
|
+
Métrica. O valor pode ser um destes:
|
|
38
|
+
|
|
39
|
+
- [`analytics`](#analytics-2)- [`conversation_analytics`](#conversation-analytics)- [`pricing_analytics`](#pricing-analytics)- [`template_analytics`](#template-analytics)- [`template_group_analytics`](#template-group-analytics)
|
|
40
|
+
|
|
41
|
+
`analytics`
|
|
42
|
+
|
|
43
|
+
`<FILTERS>`
|
|
44
|
+
|
|
45
|
+
**Obrigatório.**
|
|
46
|
+
|
|
47
|
+
O parâmetro de filtragem de métrica. Inclua parâmetros adicionais de filtragem usando pontos.
|
|
48
|
+
|
|
49
|
+
Consulte possíveis valores nestas seções:
|
|
50
|
+
|
|
51
|
+
- [Parâmetros de análise de mensagens](#messaging-analytics-parameters)- [Parâmetros de análise de conversas](#conversation-analytics-parameters)- [Parâmetros de análise de modelos](#template-analytics-parameters)- [Parâmetros de análise de grupo de modelos](#template-group-analytics-parameters)
|
|
52
|
+
|
|
53
|
+
`.start(1543543200).end(1544148000).granularity(DAY)`
|
|
54
|
+
|
|
55
|
+
## Análise de mensagens
|
|
56
|
+
|
|
57
|
+
O campo `analytics` fornece o número e o tipo de mensagens enviadas e entregues por números de telefone associados a uma WABA específica. Para saber mais sobre métricas de conversa, consulte [Análise de conversas](#conversation-analytics). Quando você chamar `/<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=analytics.{filtering-parameters}`, será possível anexar os parâmetros a seguir.
|
|
58
|
+
|
|
59
|
+
### Parâmetros de análise de mensagens
|
|
60
|
+
|
|
61
|
+
Nome
|
|
62
|
+
|
|
63
|
+
Descrição
|
|
64
|
+
|
|
65
|
+
`start`
|
|
66
|
+
|
|
67
|
+
Tipo: registro de data e hora UNIX
|
|
68
|
+
|
|
69
|
+
**Obrigatório.**
|
|
70
|
+
|
|
71
|
+
A data de início do intervalo para o qual você está recuperando análises.
|
|
72
|
+
|
|
73
|
+
`end`
|
|
74
|
+
|
|
75
|
+
Tipo: registro de data e hora UNIX
|
|
76
|
+
|
|
77
|
+
**Obrigatório.**
|
|
78
|
+
|
|
79
|
+
É a data de término do intervalo para o qual você está recuperando análises.
|
|
80
|
+
|
|
81
|
+
`granularity`
|
|
82
|
+
|
|
83
|
+
tipo: Cadeia de caracteres
|
|
84
|
+
|
|
85
|
+
**Obrigatório.**
|
|
86
|
+
|
|
87
|
+
É o detalhamento desejado para a análise. Opções compatíveis:
|
|
88
|
+
|
|
89
|
+
- `HALF_HOUR`- `DAY`- `MONTH`
|
|
90
|
+
|
|
91
|
+
`phone_numbers`
|
|
92
|
+
|
|
93
|
+
tipo: matriz
|
|
94
|
+
|
|
95
|
+
**Opcional.**
|
|
96
|
+
|
|
97
|
+
É a matriz de números de telefone referentes à análise que você quer recuperar. Caso não seja fornecida, todos os números de telefone adicionados à sua WABA serão incluídos.
|
|
98
|
+
|
|
99
|
+
`product_types`
|
|
100
|
+
|
|
101
|
+
tipo: matriz
|
|
102
|
+
|
|
103
|
+
**Opcional.**
|
|
104
|
+
|
|
105
|
+
São os tipos de mensagens referentes à análise que você quer recuperar (mensagens de notificação e/ou de suporte ao cliente). Forneça uma matriz e inclua `0` para mensagens de notificação e `2` para mensagens de suporte ao cliente. Caso a matriz não seja fornecida, retornaremos análises para todas as mensagens.
|
|
106
|
+
|
|
107
|
+
`country_codes`
|
|
108
|
+
|
|
109
|
+
tipo: matriz
|
|
110
|
+
|
|
111
|
+
**Opcional.**
|
|
112
|
+
|
|
113
|
+
São os países referentes à análise que você quer recuperar. Forneça uma matriz com códigos de duas letras para os países a serem incluídos. Caso a matriz não seja fornecida, retornaremos análises para todos os países com os quais você se comunicou.
|
|
114
|
+
|
|
115
|
+
### Exemplo
|
|
116
|
+
|
|
117
|
+
**Cenário**: você precisa do número de mensagens enviadas e entregues por todos os números de telefone associados à sua WABA.
|
|
118
|
+
|
|
119
|
+
**Solução sugerida**: [monte o URL que você quer chamar](#getting-the-data) e inclua os parâmetros de filtragem `start`, `end` e `granularity`. Depois disso, faça uma solicitação `GET` à URL:
|
|
120
|
+
|
|
121
|
+
```
|
|
122
|
+
curl -i -X GET "https://graph.facebook.com/v24.0/102290129340398
|
|
123
|
+
?fields=analytics
|
|
124
|
+
.start(1543543200)
|
|
125
|
+
.end(1544148000)
|
|
126
|
+
.granularity(DAY)
|
|
127
|
+
&access_token=BLI8lkj..."
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
Uma resposta bem-sucedida retornará um objeto `analytics` com os dados solicitados:
|
|
131
|
+
|
|
132
|
+
```
|
|
133
|
+
{ "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, "delivered": 58830 }, { "start": 1543802400, "end": 1543888800, "sent": 132465, "delivered": 124392 } # more data points ] }, "id": "102290129340398"}
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Análise de conversas
|
|
137
|
+
|
|
138
|
+
O campo `conversation_analytics` fornece [informações de custo e conversa](/documentation/business-messaging/whatsapp/pricing#conversations) para uma WABA específica. Quando você chamar `/<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=conversation_analytics.{filtering-parameters}`, será possível anexar os seguintes parâmetros.
|
|
139
|
+
|
|
140
|
+
### Parâmetros de análise de conversas
|
|
141
|
+
|
|
142
|
+
Nome
|
|
143
|
+
|
|
144
|
+
Descrição _(clique na seta da coluna da esquerda para ver as opções compatíveis.)_
|
|
145
|
+
|
|
146
|
+
`start`
|
|
147
|
+
|
|
148
|
+
Tipo: registro de data e hora UNIX
|
|
149
|
+
|
|
150
|
+
**Obrigatório.**
|
|
151
|
+
|
|
152
|
+
A data de início do intervalo para o qual você está recuperando análises.
|
|
153
|
+
|
|
154
|
+
`end`
|
|
155
|
+
|
|
156
|
+
Tipo: registro de data e hora UNIX
|
|
157
|
+
|
|
158
|
+
**Obrigatório.**
|
|
159
|
+
|
|
160
|
+
É a data de término do intervalo para o qual você está recuperando análises.
|
|
161
|
+
|
|
162
|
+
`granularity`
|
|
163
|
+
|
|
164
|
+
tipo: Cadeia de caracteres
|
|
165
|
+
|
|
166
|
+
**Obrigatório.**
|
|
167
|
+
|
|
168
|
+
É o detalhamento desejado para a análise. Opções compatíveis:
|
|
169
|
+
|
|
170
|
+
- `HALF_HOUR`- `DAILY`- `MONTHLY`
|
|
171
|
+
|
|
172
|
+
`phone_numbers`
|
|
173
|
+
|
|
174
|
+
tipo: matriz
|
|
175
|
+
|
|
176
|
+
**Opcional.**
|
|
177
|
+
|
|
178
|
+
É a matriz de números de telefone referentes à análise que você quer recuperar. Caso não seja fornecida, todos os números de telefone adicionados à sua WABA serão incluídos.
|
|
179
|
+
|
|
180
|
+
`metric_types`
|
|
181
|
+
|
|
182
|
+
**Opcional.**
|
|
183
|
+
|
|
184
|
+
É a lista de métricas que você quer receber. Se você enviar uma lista vazia, retornaremos resultados para todos os tipos de métrica. Opções compatíveis {#supported}
|
|
185
|
+
|
|
186
|
+
- `COST`: inclui cobranças aproximadas para esse período, na moeda da WABA.- `CONVERSATION`: inclui a contagem de conversas para esse período.
|
|
187
|
+
|
|
188
|
+
**Desde 1º de julho de 2023, `COST` não é mais exibido para empresas que cobram por meio de um parceiro de solução.** Para entender as cobranças, entre em contato com seu parceiro. Se você cobra por meio de um parceiro, este é o comportamento esperado:
|
|
189
|
+
|
|
190
|
+
- Se nenhum `metric_types` for especificado na solicitação, somente `CONVERSATION` será retornado.- Se apenas `CONVERSATION` for especificado, somente `CONVERSATION` será retornado.- Caso somente COST seja especificado, a seguinte exceção será retornada:
|
|
191
|
+
- Título: "Custo não disponível"- Mensagem: "O custo não é mais exibido para empresas que cobram por meio de um parceiro (ou seja, BSP). Para entender as cobranças, entre em contato com seu parceiro."
|
|
192
|
+
|
|
193
|
+
Se você consultar um período que inclua 1º de julho de 2023 (por exemplo, 1º de maio a 1º de agosto de 2023), a resposta incluirá a exceção acima.
|
|
194
|
+
|
|
195
|
+
**_Não há alterações para parceiros que consultarem o ponto de extremidade `conversation_analytics`._**
|
|
196
|
+
|
|
197
|
+
`conversation_categories`
|
|
198
|
+
|
|
199
|
+
**Opcional.**
|
|
200
|
+
|
|
201
|
+
Lista de [categorias de conversa](/documentation/business-messaging/whatsapp/pricing#conversation-categories). Se você enviar uma lista vazia, retornaremos resultados para todas as categorias de conversa. Opções compatíveis:
|
|
202
|
+
|
|
203
|
+
- `AUTHENTICATION`- `MARKETING`- `SERVICE`- `UTILITY`
|
|
204
|
+
|
|
205
|
+
`conversation_types`
|
|
206
|
+
|
|
207
|
+
**Opcional.**
|
|
208
|
+
|
|
209
|
+
É uma lista de tipos de conversa. Se você enviar uma lista vazia, retornaremos resultados para todos os tipos de conversa. Opções compatíveis:
|
|
210
|
+
|
|
211
|
+
- `FREE_ENTRY`: conversas que têm origem em um [ponto de entrada gratuito](/documentation/business-messaging/whatsapp/pricing#free-entry-point-windows).- `FREE_TIER`: conversas realizadas dentro do [nível gratuito](/documentation/business-messaging/whatsapp/pricing#free-entry-point-windows) mensal.- `REGULAR`: qualquer conversa que não tenha sido originada em um [ponto de entrada gratuito](/documentation/business-messaging/whatsapp/pricing#free-entry-point-windows) ou que ultrapasse a cota mensal do nível gratuito.
|
|
212
|
+
|
|
213
|
+
`conversation_directions`
|
|
214
|
+
|
|
215
|
+
**Opcional.**
|
|
216
|
+
|
|
217
|
+
É uma lista de direções de conversa. Se você enviar uma lista vazia, retornaremos resultados para todas as direções de conversa. Opções compatíveis:
|
|
218
|
+
|
|
219
|
+
- `BUSINESS_INITIATED`: conversas iniciadas pela empresa.- `USER_INITIATED`: conversas iniciadas por um usuário/cliente.- `UNKNOWN`: o sistema não consegue determinar a direção.
|
|
220
|
+
|
|
221
|
+
`dimensions`
|
|
222
|
+
|
|
223
|
+
**Opcional.**
|
|
224
|
+
|
|
225
|
+
É a lista de detalhamentos que você quer aplicar às suas métricas. Se você enviar uma lista vazia, retornaremos os resultados sem detalhamento. Opções compatíveis:
|
|
226
|
+
|
|
227
|
+
- `CONVERSATION_CATEGORY`- `CONVERSATION_DIRECTION`- `CONVERSATION_TYPE`- `COUNTRY`- `PHONE`
|
|
228
|
+
|
|
229
|
+
Os dados de análise são aproximados e podem ser diferentes do que aparece nas faturas devido a pequenas variações no processamento.
|
|
230
|
+
|
|
231
|
+
### Exemplos
|
|
232
|
+
|
|
233
|
+
Ao definir um período, você pode consultar informações de conversas e custos associadas à sua WABA. É possível filtrar e detalhar os resultados. Consulte os exemplos de código abaixo.
|
|
234
|
+
|
|
235
|
+
#### Consultar dados mensais usando todos os detalhamentos
|
|
236
|
+
|
|
237
|
+
**Cenário**: em um determinado mês, você quer recuperar informações de conversa e custo de todos os números de telefone associados a uma WABA.
|
|
238
|
+
|
|
239
|
+
**Solução sugerida**: [monte o URL que você quer chamar](#getting-the-data) e inclua estes parâmetros de filtragem.
|
|
240
|
+
|
|
241
|
+
- `start`: indica o início do período. Nesse caso, é o início do mês referente às métricas que você quer ver.- `end`: indica o término do período. Nesse caso, é o término do mês para o qual você que ver as métricas.- `granularity`: representa o detalhamento desejado para os pontos de dados. No exemplo abaixo, usamos `MONTHLY` para que cada ponto represente o valor de um mês de dados.- `phone_numbers`: ao enviar uma matriz vazia, retornaremos informações para todos os números de telefone associados à WABA.- `dimensions`: defina todos os detalhamentos disponíveis: `"CONVERSATION_CATEGORY"`, `"CONVERSATION_TYPE"`, `"COUNTRY"` e `"PHONE"`.
|
|
242
|
+
|
|
243
|
+
Nesse caso, não é preciso especificar `country_codes`, `metric_types`, `conversation_types` nem `conversation_categories`. Se você não enviar um valor para esses campos, retornaremos todas as opções disponíveis. Depois de configurar o URL, faça uma solicitação GET:
|
|
244
|
+
|
|
245
|
+
```
|
|
246
|
+
curl -i -X GET
|
|
247
|
+
"https://graph.facebook.com/v24.0/102290129340398
|
|
248
|
+
?fields=conversation_analytics
|
|
249
|
+
.start(1685602800).end(1688194800)
|
|
250
|
+
.granularity(MONTHLY)
|
|
251
|
+
.phone_numbers([])
|
|
252
|
+
.dimensions(["CONVERSATION_CATEGORY","CONVERSATION_TYPE","COUNTRY","PHONE"])
|
|
253
|
+
&access_token=BLI8lkj..."
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
Uma resposta bem-sucedida retornará um objeto `conversation_analytics` com os dados solicitados. No exemplo a seguir, a WABA contém apenas um número de telefone.
|
|
257
|
+
|
|
258
|
+
```
|
|
259
|
+
{ "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, "conversation": 1568, "phone_number": "15550458206", "country": "US", "conversation_type": "FREE_TIER", "conversation_category": "AUTHENTICATION", "cost": 15.68 }, { "start": 1685602800, "end": 1688194800, "conversation": 2716, "phone_number": "15550458206", "country": "US", "conversation_type": "FREE_TIER", "conversation_category": "MARKETING", "cost": 27.16 }, { "start": 1685602800, "end": 1688194800, "conversation": 2180, "phone_number": "15550458206", "country": "US", "conversation_type": "FREE_TIER", "conversation_category": "SERVICE", "cost": 21.8 }, { "start": 1685602800, "end": 1688194800, "conversation": 1465, "phone_number": "15550458206", "country": "US", "conversation_type": "FREE_TIER", "conversation_category": "UTILITY", "cost": 14.65 }, { "start": 1685602800, "end": 1688194800, "conversation": 1433, "phone_number": "15550458206", "country": "US", "conversation_type": "FREE_ENTRY_POINT", "conversation_category": "SERVICE", "cost": 14.33 } ] } ] }, "id": "102290129340398",}
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
#### Como consultar dados de um número específico usando todos os detalhamentos e a granularidade de meia hora
|
|
263
|
+
|
|
264
|
+
**Cenário**: em um determinado período, você quer recuperar informações de conversa e custo de um número de telefone específico associado a uma WABA. Sua intenção é usar todos os detalhamentos possíveis nos resultados. É preciso que cada ponto represente meia hora de dados.
|
|
265
|
+
|
|
266
|
+
**Solução sugerida**: [monte a URL que você quer chamar](#getting-the-data) e inclua estes parâmetros de filtragem:
|
|
267
|
+
|
|
268
|
+
- `start`: indica o início do período.- `end`: indica o término do período.- `granularity`: representa o detalhamento desejado para os pontos de dados. No exemplo abaixo, usamos `HALF_HOUR` para que cada ponto represente o valor de meia hora de dados.- `phone_numbers`: o número de telefone sobre o qual você precisa de informações.- `dimensions`: defina todos os detalhamentos disponíveis: `CONVERSATION_CATEGORY`, `CONVERSATION_TYPE`, `COUNTRY` e `PHONE`.
|
|
269
|
+
|
|
270
|
+
Nesse caso, não é preciso especificar `country_codes`, `metric_types`, `conversation_types` nem `conversation_categories`. Se você não enviar um valor para esses campos, retornaremos todas as opções disponíveis. Depois de configurar o URL, faça uma solicitação GET:
|
|
271
|
+
|
|
272
|
+
```
|
|
273
|
+
curl -i -X GET \
|
|
274
|
+
"https://graph.facebook.com/v24.0/102290129340398
|
|
275
|
+
?fields=conversation_analytics
|
|
276
|
+
.start(1685602800)
|
|
277
|
+
.end(1685689200)
|
|
278
|
+
.granularity(HALF_HOUR)
|
|
279
|
+
.phone_numbers(["19195552584"])
|
|
280
|
+
.dimensions(["CONVERSATION_CATEGORY","CONVERSATION_TYPE","COUNTRY,PHONE"])
|
|
281
|
+
&access_token=BLI8lkj..."
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
Uma resposta bem-sucedida retornará um objeto `conversation_analytics` com os dados solicitados:
|
|
285
|
+
|
|
286
|
+
```
|
|
287
|
+
{ "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", "cost": 0.0232 }, # ... more data points ] } ] }, "id": "102290129340398"}
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
#### Consultar dados mensais usando detalhamentos de tipo de conversa
|
|
291
|
+
|
|
292
|
+
**Cenário**: em um determinado período, você quer recuperar as informações de conversa e custo de todos os números de telefone associados a uma WABA. Sua intenção é detalhar os resultados por tipo de conversa.
|
|
293
|
+
|
|
294
|
+
**Solução sugerida**: [monte o URL que você quer chamar](#getting-the-data) e inclua estes parâmetros de filtragem:
|
|
295
|
+
|
|
296
|
+
- `start`: indica o início do período.- `end`: indica o término do período.- `granularity`: representa o detalhamento desejado para os pontos de dados. No exemplo abaixo, usamos `MONTHLY` para que cada ponto represente o valor de meio mês de dados.- `phone_numbers`: se você enviar uma matriz vazia, retornaremos informações sobre todos os números de telefone associados à WABA.- `dimensions`: defina como `CONVERSATION_TYPE`.
|
|
297
|
+
|
|
298
|
+
Nesse caso, não é preciso especificar `country_codes`, `metric_types`, `conversation_types`, `conversation_directions` nem `conversation_categories`. Se você não enviar um valor para esses campos, retornaremos todas as opções disponíveis. Depois de configurar o URL, faça uma solicitação GET:
|
|
299
|
+
|
|
300
|
+
```
|
|
301
|
+
curl -i -X GET "https://graph.facebook.com/v24.0/102290129340398
|
|
302
|
+
?fields=conversation_analytics
|
|
303
|
+
.start(1643702400).end(1646121600)
|
|
304
|
+
.granularity(MONTHLY)
|
|
305
|
+
.phone_numbers([])
|
|
306
|
+
.dimensions([CONVERSATION_TYPE])
|
|
307
|
+
&access_token=BLI8lkj..."
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
Uma resposta bem-sucedida retornará um objeto `conversation_analytics` com os dados solicitados:
|
|
311
|
+
|
|
312
|
+
```
|
|
313
|
+
{ "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 } ] } ]}
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
#### Consultar dados de meia hora detalhados por categoria de conversa
|
|
317
|
+
|
|
318
|
+
Solicitação:
|
|
319
|
+
|
|
320
|
+
```
|
|
321
|
+
curl -i -X GET "https://graph.facebook.com/v24.0/102290129340398
|
|
322
|
+
?fields=conversation_analytics
|
|
323
|
+
.start(1685527200)
|
|
324
|
+
.end(1685613600)
|
|
325
|
+
.granularity(HALF_HOUR)
|
|
326
|
+
.conversation_categories(["MARKETING","AUTHENTICATION"])
|
|
327
|
+
.dimensions(["CONVERSATION_CATEGORY"])
|
|
328
|
+
&access_token=BLI8lkj..."
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
Resposta:
|
|
332
|
+
|
|
333
|
+
```
|
|
334
|
+
{ "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"}
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
#### Consultar dados de meia hora detalhados por tipo e categoria de conversa
|
|
338
|
+
|
|
339
|
+
Solicitação:
|
|
340
|
+
|
|
341
|
+
```
|
|
342
|
+
curl -i -X GET \
|
|
343
|
+
"https://graph.facebook.com/v24.0/102290129340398
|
|
344
|
+
?fields=conversation_analytics
|
|
345
|
+
.start(1685527200)
|
|
346
|
+
.end(1685613600)
|
|
347
|
+
.granularity(HALF_HOUR)
|
|
348
|
+
.conversation_categories(["MARKETING","AUTHENTICATION"])
|
|
349
|
+
.dimensions(["CONVERSATION_CATEGORY","CONVERSATION_TYPE"])
|
|
350
|
+
&access_token=BLI8lkj..."
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
Resposta:
|
|
354
|
+
|
|
355
|
+
```
|
|
356
|
+
{ "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"}
|
|
357
|
+
```
|
|
358
|
+
|
|
359
|
+
## Análise de preços
|
|
360
|
+
|
|
361
|
+
Com o campo `pricing_analytics`, é possível consultar detalhamentos de preços para mensagens entregues em um intervalo de datas específico.
|
|
362
|
+
|
|
363
|
+
### Sintaxe da solicitação
|
|
364
|
+
|
|
365
|
+
```
|
|
366
|
+
GET /<WHATSAPP_BUSINESS_ACCOUNT_ID>
|
|
367
|
+
?fields=pricing_analytics
|
|
368
|
+
.start(<START>)
|
|
369
|
+
.end(<END>)
|
|
370
|
+
.granularity(<GRANULARITY>)
|
|
371
|
+
.phone_numbers(<PHONE_NUMBERS>)
|
|
372
|
+
.country_codes(<COUNTRY_CODES>)
|
|
373
|
+
.metric_types(<METRIC_TYPES>)
|
|
374
|
+
.pricing_types(<PRICING_TYPES>)
|
|
375
|
+
.pricing_categories(<PRICING_CATEGORIES>)
|
|
376
|
+
.dimensions(<DIMENSIONS>)
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
### Parâmetros de análise de preços
|
|
380
|
+
|
|
381
|
+
Filtro
|
|
382
|
+
|
|
383
|
+
Descrição
|
|
384
|
+
|
|
385
|
+
Valor de exemplo
|
|
386
|
+
|
|
387
|
+
`<COUNTRY_CODES>`
|
|
388
|
+
|
|
389
|
+
_Matriz de strings_
|
|
390
|
+
|
|
391
|
+
**Opcional.**
|
|
392
|
+
|
|
393
|
+
São os países referentes à análise que você quer recuperar. Forneça uma matriz com códigos de duas letras para os países a serem incluídos. Caso a matriz não seja fornecida, retornaremos análises para todos os países com os quais você se comunicou.
|
|
394
|
+
|
|
395
|
+
`[ US, BR ]`
|
|
396
|
+
|
|
397
|
+
`<DIMENSIONS>`
|
|
398
|
+
|
|
399
|
+
_Matriz de strings_
|
|
400
|
+
|
|
401
|
+
**Opcional.**
|
|
402
|
+
|
|
403
|
+
É a lista de detalhamentos que você quer aplicar às suas métricas. Se você enviar uma lista vazia, retornaremos os resultados sem detalhamento.
|
|
404
|
+
|
|
405
|
+
Os valores podem ser os seguintes:
|
|
406
|
+
|
|
407
|
+
- `COUNTRY`- `PHONE`- `PRICING_CATEGORY`- `PRICING_TYPE`- `TIER`
|
|
408
|
+
|
|
409
|
+
`[ PRICING_CATEGORY, PRICING_TYPE, COUNTRY ]`
|
|
410
|
+
|
|
411
|
+
`<END>`
|
|
412
|
+
|
|
413
|
+
_Registro de data e hora UNIX_
|
|
414
|
+
|
|
415
|
+
**Obrigatório.**
|
|
416
|
+
|
|
417
|
+
É o registro de data e hora UNIX indicando a data de término do intervalo para o qual você está recuperando análises.
|
|
418
|
+
|
|
419
|
+
`1728581152`
|
|
420
|
+
|
|
421
|
+
`<GRANULARITY>`
|
|
422
|
+
|
|
423
|
+
_String_
|
|
424
|
+
|
|
425
|
+
**Obrigatório.**
|
|
426
|
+
|
|
427
|
+
É o detalhamento desejado para a análise. O valor pode ser um destes:
|
|
428
|
+
|
|
429
|
+
- `DAILY`- `HALF_HOUR`- `MONTHLY`
|
|
430
|
+
|
|
431
|
+
`DAILY`
|
|
432
|
+
|
|
433
|
+
`<METRIC_TYPES>`
|
|
434
|
+
|
|
435
|
+
_Matriz de strings_
|
|
436
|
+
|
|
437
|
+
**Opcional.**
|
|
438
|
+
|
|
439
|
+
É a matriz de métricas que você quer receber. Se você enviar uma matriz vazia, retornaremos resultados para todos os tipos de métrica.
|
|
440
|
+
|
|
441
|
+
Os valores podem ser os seguintes:
|
|
442
|
+
|
|
443
|
+
- `COST`: cobranças aproximadas por mensagens entregues nesse período na moeda da WABA.- `VOLUME`: inclui o número de mensagens entregues nesse período.
|
|
444
|
+
|
|
445
|
+
`[COST, VOLUME]`
|
|
446
|
+
|
|
447
|
+
`<PHONE_NUMBERS>`
|
|
448
|
+
|
|
449
|
+
_Matriz de strings_
|
|
450
|
+
|
|
451
|
+
**Opcional.**
|
|
452
|
+
|
|
453
|
+
É a matriz de números de telefone referentes à análise que você quer recuperar. Caso não seja fornecida, os dados de todos os números de telefone comerciais associados à sua WABA serão incluídos.
|
|
454
|
+
|
|
455
|
+
`[ 15550783881, 15550783882, 15550783883 ]`
|
|
456
|
+
|
|
457
|
+
`<PRICING_CATEGORIES>`
|
|
458
|
+
|
|
459
|
+
_Matriz de strings_
|
|
460
|
+
|
|
461
|
+
**Opcional.**
|
|
462
|
+
|
|
463
|
+
É a matriz de categorias de preços. Se você enviar uma matriz vazia, retornaremos resultados para todas as categorias de preços.
|
|
464
|
+
|
|
465
|
+
Os valores podem ser os seguintes:
|
|
466
|
+
|
|
467
|
+
- `AUTHENTICATION`: mensagens cobradas por taxa de autenticação.- `AUTHENTICATION_INTERNATIONAL`: mensagens cobradas por taxa internacional de autenticação.- `MARKETING`: mensagens cobradas por taxa de marketing.- `SERVICE`: mensagens que não foram cobradas. Inclui todas as mensagens sem modelo e mensagens de utilidade enviadas na janela de atendimento ao cliente.- `UTILITY`: mensagens cobradas por taxa de utilidade.- `REFERRAL_CONVERSION`: mensagens que foram recebidas por meio de um [ponto de entrada gratuito](/documentation/business-messaging/whatsapp/pricing#free-entry-point-windows)
|
|
468
|
+
|
|
469
|
+
`[ AUTHENTICATION, MARKETING, UTILITY ]`
|
|
470
|
+
|
|
471
|
+
`<PRICING_TYPES>`
|
|
472
|
+
|
|
473
|
+
_Matriz de strings_
|
|
474
|
+
|
|
475
|
+
**Opcional.**
|
|
476
|
+
|
|
477
|
+
É a matriz de tipos de preços. Se você enviar uma matriz vazia, retornaremos resultados para todos os tipos de preços.
|
|
478
|
+
|
|
479
|
+
Os valores podem ser os seguintes:
|
|
480
|
+
|
|
481
|
+
- `FREE_CUSTOMER_SERVICE`: mensagens gratuitas. Inclui mensagens sem modelo e mensagens de utilidade enviadas na janela de atendimento ao cliente.- `FREE_ENTRY_POINT`: todas as mensagens enviadas na janela de atendimento ao cliente com ponto de entrada gratuito.- `REGULAR`: mensagens faturáveis. Inclui todas as mensagens de modelo de autenticação e marketing e mensagens de modelo de utilidade enviadas fora da janela de atendimento ao cliente. Exclui todas as mensagens enviadas na janela de atendimento ao cliente com ponto de entrada gratuito.
|
|
482
|
+
|
|
483
|
+
`[ REGULAR, FREE_CUSTOMER_SERVICE ]`
|
|
484
|
+
|
|
485
|
+
`<START>`
|
|
486
|
+
|
|
487
|
+
_Registro de data e hora UNIX_
|
|
488
|
+
|
|
489
|
+
**Obrigatório.**
|
|
490
|
+
|
|
491
|
+
É o registro de data e hora UNIX indicando a data de início do intervalo para o qual você está recuperando análises.
|
|
492
|
+
|
|
493
|
+
`1726014453`
|
|
494
|
+
|
|
495
|
+
`<WABA_ID>`
|
|
496
|
+
|
|
497
|
+
_String_
|
|
498
|
+
|
|
499
|
+
**Obrigatório.**
|
|
500
|
+
|
|
501
|
+
É a identificação da conta do WhatsApp Business.
|
|
502
|
+
|
|
503
|
+
`102290129340398`
|
|
504
|
+
|
|
505
|
+
### Informações sobre o nível de volume
|
|
506
|
+
|
|
507
|
+
Inclua os parâmetros `TIER`, `PRICING_CATEGORY` e `COUNTRY` na matriz `dimensions` para receber informações sobre o nível de volume. Os pontos de dados que representam mensagens afetadas pelo preço por nível de volume terão a propriedade `tier` na resposta.
|
|
508
|
+
|
|
509
|
+
#### Exemplo de sintaxe da resposta com informações sobre nível
|
|
510
|
+
|
|
511
|
+
```
|
|
512
|
+
{
|
|
513
|
+
"start": <START_TIMESTAMP>,
|
|
514
|
+
"end": <END_TIMESTAMP>,
|
|
515
|
+
"phone_number": "<BUSINESS_PHONE_NUMBER>",
|
|
516
|
+
"country": "<COUNTRY_CODE>",
|
|
517
|
+
"tier": "<LOWER>:<UPPER>",
|
|
518
|
+
"pricing_type": "<PRICING_TYPE>",
|
|
519
|
+
"pricing_category": "<PRICING_CATEGORY>",
|
|
520
|
+
"volume": <VOLUME>,
|
|
521
|
+
"cost": <COST>
|
|
522
|
+
}
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
O valor da propriedade `tier` representa uma concatenação dos limites inferior e superior para o nível específico do par mercado e categoria (`country` e `pricing_category`) que esse ponto de dados representa.
|
|
526
|
+
|
|
527
|
+
- `<LOWER>`: é um número inteiro que representa o limite inferior do nível (inclusivo).- `<UPPER>`: é um número inteiro que representa o limite superior do nível (inclusivo) ou a string `MAX`.
|
|
528
|
+
|
|
529
|
+
**Observações**
|
|
530
|
+
|
|
531
|
+
- Para verificar o nível de volume atual, leia os valores `tier`, `country` e `pricing_category`. O número inteiro `<UPPER>` de `tier` (o número inteiro depois dos dois pontos) indica o seu nível atual para `country` e `pricing_category` (por exemplo, Índia e utilidade, respectivamente).- Se quiser saber quantas mensagens você precisa enviar para atingir o próximo nível em um `country` e uma `pricing_category`, subtraia o número inteiro de `volume` do número inteiro `<UPPER>` do valor do nível.- Os níveis de volume estarão disponíveis somente para mensagens de modelo de autenticação e utilidade. Para mensagens de modelo de marketing (às quais os níveis de volume não serão aplicados), o nível será definido como `0:MAX`.- A propriedade `tier` será omitida em pontos de dados que representam mensagens gratuitas, já que elas não contribuem para a contagem dos níveis.- Os níveis de volume serão determinados exclusivamente pela Meta. Todos os dados de insights são aproximados devido a pequenas variações no processamento de dados. Não se deve depositar confiança excessiva nos dados de insights.
|
|
532
|
+
|
|
533
|
+
### Exemplo de solicitação
|
|
534
|
+
|
|
535
|
+
```
|
|
536
|
+
curl 'https://graph.facebook.com/v24.0/161311403722088?fields=pricing_analytics.start(1748761200).end(1749687703).granularity(DAILY).dimensions(PRICING_CATEGORY,PRICING_TYPE,TIER,COUNTRY).country_codes(US,IN)' \
|
|
537
|
+
-H 'Authorization: Bearer EAAJB'
|
|
538
|
+
```
|
|
539
|
+
|
|
540
|
+
### Exemplo de resposta
|
|
541
|
+
|
|
542
|
+
```
|
|
543
|
+
{ "pricing_analytics": { "data": [ { "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": "FREE_CUSTOMER_SERVICE", "pricing_category": "SERVICE", "volume": 2, "cost": 0 }, { "start": 1748934000, "end": 1749020400, "country": "US", "tier": "0:MAX", "pricing_type": "REGULAR", "pricing_category": "MARKETING", "volume": 1, "cost": 10 }, { "start": 1748847600, "end": 1748934000, "country": "US", "pricing_type": "FREE_CUSTOMER_SERVICE", "pricing_category": "SERVICE", "volume": 1, "cost": 0 }, { "start": 1748847600, "end": 1748934000, "country": "US", "pricing_type": "FREE_ENTRY_POINT", "pricing_category": "SERVICE", "volume": 6, "cost": 0 }, { "start": 1748847600, "end": 1748934000, "country": "US", "tier": "0:2", "pricing_type": "REGULAR", "pricing_category": "AUTHENTICATION", "volume": 1, "cost": 10 }, { "start": 1748847600, "end": 1748934000, "country": "IN", "tier": "0:750000", "pricing_type": "REGULAR", "pricing_category": "AUTHENTICATION_INTERNATIONAL", "volume": 1, "cost": 2.3 }, { "start": 1748761200, "end": 1748847600, "country": "US", "pricing_type": "FREE_CUSTOMER_SERVICE", "pricing_category": "SERVICE", "volume": 2, "cost": 0 }, { "start": 1748761200, "end": 1748847600, "country": "US", "tier": "0:2", "pricing_type": "REGULAR", "pricing_category": "AUTHENTICATION", "volume": 1, "cost": 10 }, { "start": 1748761200, "end": 1748847600, "country": "US", "pricing_type": "FREE_CUSTOMER_SERVICE", "pricing_category": "UTILITY", "volume": 1, "cost": 0 }, { "start": 1748761200, "end": 1748847600, "country": "US", "tier": "0:2", "pricing_type": "REGULAR", "pricing_category": "UTILITY", "volume": 1, "cost": 10 }, { "start": 1748761200, "end": 1748847600, "country": "US", "tier": "0:MAX", "pricing_type": "REGULAR", "pricing_category": "MARKETING", "volume": 4, "cost": 40 }, { "start": 1748761200, "end": 1748847600, "country": "US", "tier": "0:MAX", "pricing_type": "REGULAR", "pricing_category": "MARKETING_LITE", "volume": 1, "cost": 10 } ] } ] }}
|
|
544
|
+
```
|
|
545
|
+
|
|
546
|
+
## Análise de modelos
|
|
547
|
+
|
|
548
|
+
A análise de modelos descreve o número de vezes que um modelo foi enviado, entregue e lido, além da quantidade de cliques que os botões de [URL](/documentation/business-messaging/whatsapp/templates/components#url-buttons) ou de [resposta rápida](/documentation/business-messaging/whatsapp/templates/components#quick-reply-buttons) receberam no modelo. Além disso, as empresas [MM Lite](/documentation/business-messaging/whatsapp/marketing-messages/overview) integradas podem rastrear métricas de conversão fora do site.
|
|
549
|
+
|
|
550
|
+
Os dados são retornados com granularidade diária no fuso horário padrão UTC e no fuso horário da WABA, com uma janela de retrospectiva de até 90 dias. Para mostrar dados no fuso horário configurado da WABA, transmita o parâmetro use\_waba\_timezone com um valor true.
|
|
551
|
+
|
|
552
|
+
Exibir dados no fuso horário configurado da WABA transmitindo o parâmetro `use_waba_timezone` com um valor de `true`.
|
|
553
|
+
|
|
554
|
+
```
|
|
555
|
+
{ "data": [ { "waba_timezone": "America/Los_Angeles", "granularity": "DAILY", "product_type": "cloud_api", "data_points": [ ... ] }}
|
|
556
|
+
```
|
|
557
|
+
|
|
558
|
+
### Limitações
|
|
559
|
+
|
|
560
|
+
- As análises de modelos só estarão disponíveis na API Local se a conta não estiver usando a API de Nuvem para isso.- A análise de cliques no botão está disponível apenas para modelos categorizados como `MARKETING` ou `UTILITY`.- Não há compatibilidade com WABAs pertencentes ou compartilhadas com contas empresariais da Meta na União Europeia, no Reino Unido ou no Japão, tampouco com WABAs que tenham um número de telefone comercial com código do país desses locais.- As métricas de conversão fora do site estão disponíveis apenas para empresas integradas à MM Lite.- Os dados de eventos de leitura e clique em mensagens de modelo do WhatsApp estão disponíveis por até sete dias a partir da data de envio da mensagem. Depois desse período, o número de leituras/cliques correspondente será redefinido para zero, e nenhuma outra atualização será registrada para essas mensagens.
|
|
561
|
+
|
|
562
|
+
### Como confirmar as análises de modelos
|
|
563
|
+
|
|
564
|
+
Antes de consultar as análises de modelos, é preciso confirmar esse tipo de análise na conta do WhatsApp Business. Isso pode ser feito por meio do Gerenciador do WhatsApp ou da API.
|
|
565
|
+
|
|
566
|
+
Ao confirmar o acesso via API, você instrui a Meta a adicionar insights à sua conta do WhatsApp Business. Esses insights incluem rastreamento de link para relatar os cliques no site. É possível desativar o rastreamento de links em cada modelo de mensagem. Você também instrui a Meta a coletar e anonimizar dados de conversas com clientes. A Meta anonimizará esses dados para melhorar os serviços que fornece a você e a outras empresas.
|
|
567
|
+
|
|
568
|
+
Na API, envie esta solicitação:
|
|
569
|
+
|
|
570
|
+
```
|
|
571
|
+
POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>?is_enabled_for_insights=true
|
|
572
|
+
```
|
|
573
|
+
|
|
574
|
+
Após isso, começaremos a capturar as análises desse tipo na conta do WhatsApp Business. Depois da confirmação, não é possível desabilitar as análises de modelos.
|
|
575
|
+
|
|
576
|
+
Caso a solicitação seja bem-sucedida, a API responderá com a identificação da conta do WhatsApp Business. Por exemplo:
|
|
577
|
+
|
|
578
|
+
```
|
|
579
|
+
{ "id": 102290129340398}
|
|
580
|
+
```
|
|
581
|
+
|
|
582
|
+
### Parâmetros de análise de modelos
|
|
583
|
+
|
|
584
|
+
Nome
|
|
585
|
+
|
|
586
|
+
Descrição
|
|
587
|
+
|
|
588
|
+
Valor de exemplo
|
|
589
|
+
|
|
590
|
+
`start`
|
|
591
|
+
|
|
592
|
+
_Registro de data e hora UNIX ou string de data_
|
|
593
|
+
|
|
594
|
+
**Obrigatório.**
|
|
595
|
+
|
|
596
|
+
É a hora de início do intervalo para o qual você está recuperando análises. Pode ser representado como um número inteiro de registro de data e hora UNIX ou como uma string de data no formato AAAA-MM-DD. Como as análises de modelos são fornecidas com detalhamento diário no fuso horário UTC, os registros de data e hora de início em outros horários ou fusos serão ajustados para a 00:00 UTC do dia vigente.
|
|
597
|
+
|
|
598
|
+
Se o parâmetro `use_waba_timezone` tiver um valor "true", esse valor deverá ser uma string de data no formato AAAA-MM-DD.
|
|
599
|
+
|
|
600
|
+
`1543536000`
|
|
601
|
+
|
|
602
|
+
`end`
|
|
603
|
+
|
|
604
|
+
_Registro de data e hora UNIX ou string de data_
|
|
605
|
+
|
|
606
|
+
**Obrigatório.**
|
|
607
|
+
|
|
608
|
+
É a hora de término do intervalo para o qual você está recuperando análises. Pode ser representado como um número inteiro de registro de data e hora UNIX ou como uma string de data no formato AAAA-MM-DD. Como as análises de modelos são fornecidas com detalhamento diário no fuso horário UTC, os registros de data e hora de término em outros horários ou fusos serão ajustados para a 00:00 UTC do dia vigente.
|
|
609
|
+
|
|
610
|
+
Se o parâmetro `use_waba_timezone` tiver um valor "true", esse valor deverá ser uma string de data no formato AAAA-MM-DD.
|
|
611
|
+
|
|
612
|
+
`1543708800`
|
|
613
|
+
|
|
614
|
+
`granularity`
|
|
615
|
+
|
|
616
|
+
_Enumeração_
|
|
617
|
+
|
|
618
|
+
**Obrigatório.**
|
|
619
|
+
|
|
620
|
+
É o detalhamento desejado para a análise. O valor deve ser `DAILY`.
|
|
621
|
+
|
|
622
|
+
`DAILY`
|
|
623
|
+
|
|
624
|
+
`template_ids`
|
|
625
|
+
|
|
626
|
+
_Matriz de IDs_
|
|
627
|
+
|
|
628
|
+
**Obrigatório.**
|
|
629
|
+
|
|
630
|
+
É a matriz de IDs de modelos referentes à análise que você quer recuperar.
|
|
631
|
+
|
|
632
|
+
Máximo de 10.
|
|
633
|
+
|
|
634
|
+
`[1924084211297547,954638012257287,969725530748535]`
|
|
635
|
+
|
|
636
|
+
`metric_types`
|
|
637
|
+
|
|
638
|
+
_Matriz de enumerações_
|
|
639
|
+
|
|
640
|
+
**Opcional.**
|
|
641
|
+
|
|
642
|
+
O nó `COST` NÃO está disponível para empresas que fazem o faturamento através de um parceiro de solução. Para entender as cobranças, entre em contato com seu parceiro.
|
|
643
|
+
|
|
644
|
+
Os tipos de métricas a serem recuperadas. Se a matriz for omitida ou estiver vazia, serão retornadas as análises de todos os tipos de métricas.
|
|
645
|
+
|
|
646
|
+
Valores possíveis:
|
|
647
|
+
|
|
648
|
+
- `COST`- `CLICKED`- `DELIVERED`- `READ`- `SENT`- `APP_ACTIVATIONS (MM Lite only)`- `APP_ADD_TO_CART (MM Lite only)`- `APP_CHECKOUTS_INITIATED (MM Lite only)`- `APP_PURCHASES (MM Lite only)`- `APP_PURCHASES_CONVERSION_VALUE (MM Lite only)`- `WEBSITE_ADD_TO_CART (MM Lite only)`- `WEBSITE_CHECKOUTS_INITIATED (MM Lite only)`- `WEBSITE_PURCHASES (MM Lite only)`- `WEBSITE_PURCHASES_CONVERSION_VALUE (MM Lite only)`
|
|
649
|
+
|
|
650
|
+
Saiba mais sobre custos e métricas de clique [neste link](/documentation/business-messaging/whatsapp/analytics#cost-and-click-metrics).
|
|
651
|
+
|
|
652
|
+
`[SENT,DELIVERED,READ]`
|
|
653
|
+
|
|
654
|
+
`product_type`
|
|
655
|
+
|
|
656
|
+
_Enumeração_
|
|
657
|
+
|
|
658
|
+
**Opcional.**
|
|
659
|
+
|
|
660
|
+
O tipo de produto das métricas a serem recuperadas. Se omitido, serão retornadas somente análises da API de Nuvem.
|
|
661
|
+
|
|
662
|
+
Valores possíveis:
|
|
663
|
+
|
|
664
|
+
- `CLOUD_API` – Para filtrar métricas de modelos enviados por meio da API de Nuvem- `CLOUD_API` – Para filtrar métricas de modelos enviados por meio da API de Mensagens de Marketing Lite
|
|
665
|
+
|
|
666
|
+
`MARKETING_MESSAGES_LITE_API`
|
|
667
|
+
|
|
668
|
+
`<USE_WABA_TIMEZONE>`
|
|
669
|
+
|
|
670
|
+
_Booliano_
|
|
671
|
+
|
|
672
|
+
**Opcional.**
|
|
673
|
+
|
|
674
|
+
Indica se as métricas devem ser exibidas no fuso horário configurado da WABA. Se forem "false" ou omitidas, as métricas serão exibidas no formato UTC.
|
|
675
|
+
|
|
676
|
+
Se forem"true", os parâmetros de início e término deverão estar no formato AAAA-MM-DD.
|
|
677
|
+
|
|
678
|
+
`true`
|
|
679
|
+
|
|
680
|
+
### Exemplos
|
|
681
|
+
|
|
682
|
+
#### Como consultar todas as análises de modelos
|
|
683
|
+
|
|
684
|
+
**Cenário:** consulte todos os tipos de métricas de análise de modelos para um modelo de autenticação e um modelo de marketing com um botão de URL, considerando um período de um dia.
|
|
685
|
+
|
|
686
|
+
Exemplo de solicitação:
|
|
687
|
+
|
|
688
|
+
```
|
|
689
|
+
curl -g 'https://graph.facebook.com/v24.0/109259195336416/template_analytics?start=1718064000&end=1718122745&granularity=daily&metric_types=cost%2Cclicked%2Cdelivered%2Cread%2Csent&template_ids=[1421988012088524%2C2632273056924580]' \
|
|
690
|
+
-H 'Authorization: Bearer EAAJB...'
|
|
691
|
+
```
|
|
692
|
+
|
|
693
|
+
Exemplo de resposta:
|
|
694
|
+
|
|
695
|
+
```
|
|
696
|
+
{ "data": [ { "granularity": "DAILY", "product_type": "cloud_api", // Only available to businesses in the Marketing Messages Lite API alpha "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, "delivered": 1, "read": 1, "clicked": [ { "type": "quick_reply_button", "button_content": "Contact Support", "count": 108 }, { "type": "unique_url_button", "button_content": "Tell me more", "count": 16 } ], "cost": [ { "type": "amount_spent", "value": 0.03 }, { "type": "cost_per_delivered", "value": 0.03 }, { "type": "cost_per_url_button_click", "value": 0.03 } ] } ] } ], "paging": { "cursors": { "before": "MAZDZD", "after": "MjQZD" } }}
|
|
697
|
+
```
|
|
698
|
+
|
|
699
|
+
### Métricas de custo e clique
|
|
700
|
+
|
|
701
|
+
As **métricas de custo** são retornadas como uma matriz de objetos de custo, cada um com um tipo e valor. Os tipos podem ser:
|
|
702
|
+
|
|
703
|
+
- `amount_spent`: o valor total gasto em conversas abertas no período entre `start` e `end` como resultado do envio do modelo. Veja a seção [Preços baseados em conversas](/documentation/business-messaging/whatsapp/pricing#opening-conversations).- `cost_per_delivered`: o valor `amount_spent` dividido pelo número de vezes que o modelo foi entregue no período entre `start` e `end`.- `cost_per_url_button_click`: o valor `amount_spent` dividido pelo número de cliques no botão de URL do modelo no período entre `start` e `end`. Cliques no botão de resposta rápida não são incluídos. Objeto omitido se o modelo não tiver um botão de URL.
|
|
704
|
+
|
|
705
|
+
As **métricas de clique** são retornadas como uma matriz de objetos JSON, cada um com um tipo e valor. Os cliques são retornados apenas para botões de URL e de resposta rápida em modelos categorizados como `MARKETING` ou `UTILITY`.
|
|
706
|
+
|
|
707
|
+
Os tipos podem ser:
|
|
708
|
+
|
|
709
|
+
- `url_button` – O número total de cliques no botão de URL.- `unique_url_button` – Cliques únicos acompanham o número de contas distintas do WhatsApp que clicaram em um botão. Essa métrica ajuda você a compreender quantos usuários individuais estão interagindo com seus CTAs, eliminando cliques duplicados do mesmo destinatário e proporcionando uma mensuração precisa do engajamento.
|
|
710
|
+
|
|
711
|
+
### Como desabilitar a análise de cliques no botão
|
|
712
|
+
|
|
713
|
+
Para desabilitar o rastreamento de cliques no botão, defina o campo `cta_url_link_tracking_opted_out` de um modelo específico como `true`. Depois que o recurso for desabilitado, a API não retornará mais a propriedade "clicked" na análise do modelo nem exibirá dados de engajamento/cliques no botão no Gerenciador do WhatsApp quando você estiver visualizando os insights do modelo.
|
|
714
|
+
|
|
715
|
+
#### Sintaxe da solicitação
|
|
716
|
+
|
|
717
|
+
```
|
|
718
|
+
POST /<TEMPLATE_ID>
|
|
719
|
+
?cta_url_link_tracking_opted_out=<OPT_OUT>
|
|
720
|
+
&category=<TEMPLATE_CATEGORY>
|
|
721
|
+
```
|
|
722
|
+
|
|
723
|
+
#### Parâmetros de solicitação
|
|
724
|
+
|
|
725
|
+
Espaço reservado
|
|
726
|
+
|
|
727
|
+
Descrição
|
|
728
|
+
|
|
729
|
+
Valor de exemplo
|
|
730
|
+
|
|
731
|
+
`<WHATSAPP_TEMPLATE_ID>`
|
|
732
|
+
|
|
733
|
+
_ID do modelo_
|
|
734
|
+
|
|
735
|
+
**Obrigatório.**
|
|
736
|
+
|
|
737
|
+
O ID do modelo.
|
|
738
|
+
|
|
739
|
+
`245435364965041`
|
|
740
|
+
|
|
741
|
+
`<OPT_OUT>`
|
|
742
|
+
|
|
743
|
+
_Booliano_
|
|
744
|
+
|
|
745
|
+
**Obrigatório.**
|
|
746
|
+
|
|
747
|
+
Indica se o rastreamento de cliques no botão do modelo foi desabilitado. Defina como `true` para desabilitar o rastreamento de cliques no botão ou como `false` para habilitá-lo.
|
|
748
|
+
|
|
749
|
+
Esse valor será definido como `false` após a criação do modelo.
|
|
750
|
+
|
|
751
|
+
`true`
|
|
752
|
+
|
|
753
|
+
`<TEMPLATE_CATEGORY>`
|
|
754
|
+
|
|
755
|
+
_String_
|
|
756
|
+
|
|
757
|
+
**Obrigatório.**
|
|
758
|
+
|
|
759
|
+
A categoria atual do modelo.
|
|
760
|
+
|
|
761
|
+
Se você definir a categoria do modelo como um valor diferente da opção atual, o status do modelo será definido como `PENDING`, indicando que ele precisa passar pelo processo de análise para ser aprovado.
|
|
762
|
+
|
|
763
|
+
`marketing`
|
|
764
|
+
|
|
765
|
+
#### Exemplo de solicitação
|
|
766
|
+
|
|
767
|
+
```
|
|
768
|
+
curl -X POST 'https://graph.facebook.com/v24.0/245435364965041?cta_url_link_tracking_opted_out=true&category=marketing' \
|
|
769
|
+
-H 'Authorization: Bearer EAAJB...'
|
|
770
|
+
```
|
|
771
|
+
|
|
772
|
+
#### Exemplo de resposta
|
|
773
|
+
|
|
774
|
+
Se o processo for bem-sucedido, a API enviará a seguinte resposta:
|
|
775
|
+
|
|
776
|
+
```
|
|
777
|
+
{ "success": true}
|
|
778
|
+
```
|
|
779
|
+
|
|
780
|
+
## Análise de grupo de modelos
|
|
781
|
+
|
|
782
|
+
No campo `template_group_analytics`, é possível saber quantas vezes os modelos dentro de um [grupo de modelos](/documentation/business-messaging/whatsapp/templates/template-groups) foram enviados, entregues e lidos, além de quantas vezes os respectivos botões de [URL](/documentation/business-messaging/whatsapp/templates/components#url-buttons) ou de [resposta rápida](/documentation/business-messaging/whatsapp/templates/components#quick-reply-buttons) foram clicados.
|
|
783
|
+
|
|
784
|
+
Os dados são retornados com granularidade diária no fuso horário padrão UTC e no fuso horário da WABA, com uma janela de retrospectiva de até 90 dias. Para mostrar dados no fuso horário configurado da WABA, transmita o parâmetro use\_waba\_timezone com um valor true.
|
|
785
|
+
|
|
786
|
+
```
|
|
787
|
+
{ "data": [ { "waba_timezone": "America/Los_Angeles", "granularity": "DAILY", "product_type": "cloud_api", "data_points": [ ... ] }}
|
|
788
|
+
```
|
|
789
|
+
|
|
790
|
+
### Limitações
|
|
791
|
+
|
|
792
|
+
A análise de cliques no botão está disponível apenas para modelos categorizados como `marketing` ou `utility`. Não há compatibilidade com WABAs pertencentes ou compartilhadas com contas empresariais da Meta na União Europeia, no Reino Unido ou no Japão, tampouco com WABAs que tenham um número de telefone comercial com código do país desses locais.
|
|
793
|
+
|
|
794
|
+
### Como habilitar a análise de modelos
|
|
795
|
+
|
|
796
|
+
Antes de consultar as análises de grupo de modelos, é preciso habilitar esse tipo de análise na conta do WhatsApp Business. Isso pode ser feito por meio do Gerenciador do WhatsApp ou da API.
|
|
797
|
+
|
|
798
|
+
Ao confirmar o acesso via API, você instrui a Meta a adicionar insights à sua conta do WhatsApp Business. Esses insights incluem rastreamento de link para relatar os cliques no site. É possível desativar o rastreamento de links em cada modelo de mensagem. Você também instrui a Meta a coletar e anonimizar dados de conversas com clientes. A Meta anonimizará esses dados para melhorar os serviços que fornece a você e a outras empresas.
|
|
799
|
+
|
|
800
|
+
Para confirmar a ativação via API, envie a seguinte solicitação:
|
|
801
|
+
|
|
802
|
+
`POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>?is_enabled_for_insights=true`
|
|
803
|
+
|
|
804
|
+
Se o processo for bem-sucedido, a API responderá com a identificação da sua conta do WhatsApp Business. Além disso, começaremos a capturar as análises do grupo de modelos para essa conta.
|
|
805
|
+
|
|
806
|
+
Após a ativação, não será possível desabilitar as análises de modelos.
|
|
807
|
+
|
|
808
|
+
### Sintaxe da solicitação
|
|
809
|
+
|
|
810
|
+
```
|
|
811
|
+
GET /<WHATSAPP_BUSINESS_ACCOUNT_ID>/template_group_analytics
|
|
812
|
+
?granularity=daily
|
|
813
|
+
&start=<START_TIME>
|
|
814
|
+
&end=<END_TIME>
|
|
815
|
+
&metric_types=<METRIC_TYPES>
|
|
816
|
+
&template_group_ids=[<TEMPLATE_GROUP_IDS>]
|
|
817
|
+
```
|
|
818
|
+
|
|
819
|
+
### Parâmetros de solicitação
|
|
820
|
+
|
|
821
|
+
Espaço reservado
|
|
822
|
+
|
|
823
|
+
Descrição
|
|
824
|
+
|
|
825
|
+
Valor de exemplo
|
|
826
|
+
|
|
827
|
+
`<WABA_ID>`_String_
|
|
828
|
+
|
|
829
|
+
**Obrigatório.**
|
|
830
|
+
|
|
831
|
+
É a identificação da conta do WhatsApp Business.
|
|
832
|
+
|
|
833
|
+
`102290129340398`
|
|
834
|
+
|
|
835
|
+
`<START_TIME>`
|
|
836
|
+
|
|
837
|
+
_Registro de data e hora UNIX ou string de data_
|
|
838
|
+
|
|
839
|
+
**Obrigatório.**
|
|
840
|
+
|
|
841
|
+
É a hora de início do intervalo para o qual você está recuperando análises. Pode ser representado como um número inteiro de registro de data e hora UNIX ou como uma string de data no formato AAAA-MM-DD.
|
|
842
|
+
|
|
843
|
+
Como as análises de grupo de modelos são fornecidas com detalhamento diário no fuso horário UTC, os registros de data e hora de início em outros horários ou fusos serão ajustados para a 00:00 UTC do dia vigente.
|
|
844
|
+
|
|
845
|
+
Se o parâmetro `use_waba_timezone` tiver um valor "true", esse valor deverá ser uma string de data no formato AAAA-MM-DD.
|
|
846
|
+
|
|
847
|
+
`1738465116`
|
|
848
|
+
|
|
849
|
+
`<END_TIME>`
|
|
850
|
+
|
|
851
|
+
_Registro de data e hora UNIX ou string de data_
|
|
852
|
+
|
|
853
|
+
**Obrigatório.**
|
|
854
|
+
|
|
855
|
+
É a hora de término do intervalo para o qual você está recuperando análises. Pode ser representado como um número inteiro de registro de data e hora UNIX ou como uma string de data no formato AAAA-MM-DD.
|
|
856
|
+
|
|
857
|
+
Como as análises de grupo de modelos são fornecidas com detalhamento diário no fuso horário UTC, os registros de data e hora de término em outros horários ou fusos serão ajustados para a 00:00 UTC do dia vigente.
|
|
858
|
+
|
|
859
|
+
Se o parâmetro `use_waba_timezone param` tiver um valor "true", esse valor deverá ser uma string de data no formato AAAA-MM-DD.
|
|
860
|
+
|
|
861
|
+
`1739559516`
|
|
862
|
+
|
|
863
|
+
`<METRIC_TYPES>`
|
|
864
|
+
|
|
865
|
+
_Matriz de strings_
|
|
866
|
+
|
|
867
|
+
**Opcional.**
|
|
868
|
+
|
|
869
|
+
É a matriz de métricas que você quer receber. Se você enviar uma matriz vazia, a API retornará resultados para todos os tipos de métrica.
|
|
870
|
+
|
|
871
|
+
Os valores podem ser os seguintes:
|
|
872
|
+
|
|
873
|
+
- `cost`- `clicked`- `delivered`- `read`- `sent`
|
|
874
|
+
|
|
875
|
+
`COST` não está disponível para clientes empresariais que recebem cobranças através de um parceiro de solução.
|
|
876
|
+
|
|
877
|
+
Veja [Métricas de custo e clique](#cost-and-click-metrics-2) para saber mais sobre esses tipos de métricas.
|
|
878
|
+
|
|
879
|
+
```
|
|
880
|
+
[
|
|
881
|
+
sent,
|
|
882
|
+
delivered,
|
|
883
|
+
read
|
|
884
|
+
]
|
|
885
|
+
```
|
|
886
|
+
|
|
887
|
+
`<TEMPLATE_GROUP_IDS>`
|
|
888
|
+
|
|
889
|
+
**Obrigatório.**
|
|
890
|
+
|
|
891
|
+
É a matriz de IDs de grupo de modelos para os quais você quer consultar métricas.
|
|
892
|
+
|
|
893
|
+
É compatível com até 10 IDs.
|
|
894
|
+
|
|
895
|
+
`102290129340398`
|
|
896
|
+
|
|
897
|
+
`<USE_WABA_TIMEZONE`\>\`
|
|
898
|
+
|
|
899
|
+
_Booliano_
|
|
900
|
+
|
|
901
|
+
**Opcional.**
|
|
902
|
+
|
|
903
|
+
Indica se as métricas devem ser exibidas no fuso horário configurado da WABA. Se forem "false" ou omitidas, as métricas serão exibidas no formato UTC.
|
|
904
|
+
|
|
905
|
+
Se forem"true", os parâmetros de início e término deverão estar no formato AAAA-MM-DD.
|
|
906
|
+
|
|
907
|
+
`true`
|
|
908
|
+
|
|
909
|
+
### Exemplo de solicitação
|
|
910
|
+
|
|
911
|
+
```
|
|
912
|
+
curl -g 'https://graph.facebook.com/v24.0/102290129340398/template_group_analytics?granularity=daily&start=1738465116&end=1739559516&metric_types=sent,delivered,read&template_group_ids=[1044106240855852]' \
|
|
913
|
+
-H 'Authorization: Bearer EAAJB...'
|
|
914
|
+
```
|
|
915
|
+
|
|
916
|
+
### Exemplo de resposta
|
|
917
|
+
|
|
918
|
+
O exemplo abaixo foi truncado com uma elipse (`...`) para fins de concisão.
|
|
919
|
+
|
|
920
|
+
```
|
|
921
|
+
{ "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" } }}
|
|
922
|
+
```
|
|
923
|
+
|
|
924
|
+
### Métricas de custo e clique
|
|
925
|
+
|
|
926
|
+
As **métricas de custo** são retornadas como uma matriz de objetos de custo, cada um com um tipo e valor. Os tipos podem ser:
|
|
927
|
+
|
|
928
|
+
- `amount_spent`: o valor total gasto em conversas abertas no período entre `start` e `end` como resultado do envio do modelo. Veja a seção [Preços baseados em conversas](/documentation/business-messaging/whatsapp/pricing#opening-conversations).- `cost_per_delivered`: o valor `amount_spent` dividido pelo número de vezes que o modelo foi entregue no período entre `start` e `end`.- `cost_per_url_button_click`: o valor `amount_spent` dividido pelo número de cliques no botão de URL do modelo no período entre `start` e `end`. Cliques no botão de resposta rápida não são incluídos. Objeto omitido se o modelo não tiver um botão de URL.
|
|
929
|
+
|
|
930
|
+
As **métricas de clique** são retornadas como uma matriz de objetos JSON, cada um com um tipo e valor. Os cliques são retornados apenas para botões de URL e de resposta rápida em modelos categorizados como `marketing` ou `utility`.
|
|
931
|
+
|
|
932
|
+
Os tipos podem ser:
|
|
933
|
+
|
|
934
|
+
- `url_button` – O número total de cliques no botão de URL.- `unique_url_button` – Cliques únicos acompanham o número de contas distintas do WhatsApp que clicaram em um botão. Essa métrica ajuda você a compreender quantos usuários individuais estão interagindo com seus CTAs, eliminando cliques duplicados do mesmo destinatário e proporcionando uma mensuração precisa do engajamento.
|
|
935
|
+
|
|
936
|
+
## Referência
|
|
937
|
+
|
|
938
|
+
Para ver uma lista de todos os possíveis valores de um campo, consulte a referência da Graph API no [campo Análise da conta do WhatsApp Business](/docs/graph-api/reference/waba-analytics).
|
|
939
|
+
|
|
940
|
+
Você achou esta página útil?
|
|
941
|
+
|
|
942
|
+

|
|
943
|
+
|
|
944
|
+

|