Mediahub Rest API
  1. Facebook Ads
Mediahub Rest API
  • Introdução
  • API Reference
    • Facebook Ads
      • Accounts
        GET
      • Ads [Ad Level]
        GET
      • Ads Config [Ad Level]
        GET
      • Ads [Adset Level]
        GET
      • Ads Config [Adset Level]
        GET
      • Ads [Campaign Level]
        GET
      • Ads Config [Campaign Level]
        GET
      • Ads Actions
        GET
      • Ads Gender/Age
        GET
      • Ads Region
        GET
      • Ads Platform
        GET
      • Creatives [Deprecated]
        GET
      • Creatives with Ad
        GET
    • Google Ads
      • Accounts
      • Ads Conversions
      • Ads [Ad Group]
      • Ads [Conversion Segmented Ad Group]
      • Ads [Ad Group Ads]
      • Ads Criterion [Ad Group Ads]
      • Ads [Conversion Segmented Ad Group Ads]
      • Ads [Campaigns]
      • Ads Criterion [Campaigns]
      • Ads [Conversion Segmented Campaigns]
      • Ads Age Dimension
      • Ads Gender Dimension
      • Ads Geographic Dimension
      • Ads Keywords Dimension
    • Google Analytics
      • Google Analytics Customers
      • Google Analytics Custom Events
      • Google Analytics Events
      • Google Analytics Products
      • Google Analytics Sessions
      • Google Analytics Transactions
    • Instagram Insights
      • Instagram Age Insights
      • Instagram City Insights
      • Instagram Gender Insights
      • instagram Media Details
      • Instagram Media Insights
      • Instagram Profile
      • Instagram Profile Insights
    • TikTok
      • TikTok Budget
      • TikTok Demographic
      • TikTok Group Budget
      • TikTok Info
      • TikTok Region
    • Linkedin
      • Linkedin Statistics
      • Linkedin Accounts Campaigns
      • Linkedin Conversions Tracking
    • Bitrix
      • Bitrix Contacts
      • Bitrix Deals
      • Bitrix Won Deals
      • Bitrix Leads History
    • Kommo
      • Kommo Contacts
      • Kommo Leads
      • Kommo Pipelines
      • Kommo Users
    • Loja Integrada
      • Loja Integrada Customers
      • Loja Integrada Orders
      • Loja Integrada Products
    • Nuvem Shop
      • Nuvem Shop Customers
      • Nuvem Shop Orders
      • Nuvem Shop Products
    • Pipedrive
      • Pipedrive Deals
      • Pipedrive Leads
      • Pipedrive Lead Sources
      • Pipedrive People
      • Pipedrive Pipelines
      • Pipedrive Pipeline Stages
      • Pipedrive Products
      • Pipedrive Users
    • Rd Station
      • Rd Station Deal Stages
      • Rd Station Deals
      • Rd Station Products
    • Shopify
      • Shopify Customers
      • Shopify Orders
      • Shopify Orders Items
      • Shopify Products
    • Tray
      • Tray Customers
      • Tray Orders
      • Tray Products
    • Unbounce
      • Unbounce Leads
    • Vtex
      • Vtex Customers
      • Vtex Orders
      • Vtex Products
    • Investimentos de Mídia
      • Investimentos de Mídia
    • Integrações
      • Integrações
  1. Facebook Ads

Ads Region

GET
https://rest.api.mktlab.app/v1/facebook/ads/region
Consulta os dados de campanhas, conjuntos de anúncios e anúncios do Facebook Ads na dimensão de região.

Resposta#

A resposta retorna uma lista de dados regionais das campanhas do Facebook com os seguintes campos:
CampoTipoDescrição
adset_idstringID do conjunto de anúncios (adset) relacionado à segmentação.
ad_idstringID do anúncio relacionado à segmentação.
clicksintegerTotal de cliques registrados.
reachintegerTotal de pessoas alcançadas.
impressionsintegerTotal de impressões do anúncio.
objectivestringObjetivo da campanha (ex: CONVERSIONS, TRAFFIC, etc.).
spendfloatValor total gasto na campanha (em moeda local da conta).
date_startstringData e hora de início do período analisado (formato ISO 8601).
date_stopstringData e hora de término do período analisado (formato ISO 8601).
regionstringNome da região geográfica segmentada (ex: North America).
countrystringPaís segmentado (ex: USA).
integration_idstringID da integração da plataforma com a conta do Facebook.
project_idstringID do projeto associado à segmentação regional.
unit_idstringID da unidade de negócios associada à segmentação.
document_idstringID do documento associado à segmentação.
inserted_atstringData e hora em que o registro foi inserido no sistema (formato ISO 8601).

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros de Consulta

Respostas

🟢200Region
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://rest.api.mktlab.app/v1/facebook/ads/region' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "data": [
        {
            "adset_id": "adset12345",
            "ad_id": "ad12345",
            "clicks": 1500,
            "reach": 50000,
            "impressions": 100000,
            "objective": "CONVERSIONS",
            "spend": 1200.5,
            "date_start": "2025-03-01T00:00:00Z",
            "date_stop": "2025-03-15T23:59:59Z",
            "region": "North America",
            "country": "USA",
            "integration_id": "integration123",
            "project_id": "project456",
            "unit_id": "unit789",
            "document_id": "doc123",
            "inserted_at": "2025-03-16T12:00:00Z"
        }
    ],
    "meta": {
        "page": 1,
        "limit": 500,
        "total": 1,
        "totalPages": 1,
        "hasNextPage": false,
        "hasPreviousPage": true
    }
}
Modificado em 2025-10-08 17:25:55
Página anterior
Ads Gender/Age
Próxima página
Ads Platform
Built with