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 [Campaign Level]

GET
https://rest.api.mktlab.app/v1/facebook/ads/campaigns
Consulta os dados de anúncios do Facebook Ads trazendo suas métricas relacionadas no nível de campanha.

Resposta#

A resposta retorna uma lista de dados de campanhas do Facebook com os seguintes campos:
CampoTipoDescrição
campaign_namestringNome da campanha no Facebook.
campaign_idstringID da campanha no Facebook.
impressionsintegerQuantidade de impressões da campanha.
reachintegerQuantidade de pessoas alcançadas pela campanha.
frequencyfloatFrequência média de exibição por pessoa.
clicksintegerQuantidade de cliques recebidos.
ctrfloatTaxa de cliques (Click-Through Rate).
inline_link_clicksintegerQuantidade de cliques em links diretos.
inline_link_click_ctrfloatTaxa de cliques em links diretos.
spendfloatValor total gasto na campanha (na moeda da conta).
cpcfloatCusto médio por clique.
cpmfloatCusto médio por mil impressões.
actionsJSONAções realizadas na campanha (ex: conversões, visualizações, etc.).
date_startstringData de início da campanha (formato ISO 8601).
date_stopstringData de término da campanha (formato ISO 8601).
integration_idstringID da integração da conta do Facebook.
project_idstringID do projeto associado à campanha.
unit_idstringID da unidade de negócios associada.
document_idstringID do documento de origem dos dados.
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

🟢200Ads Campaign
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://rest.api.mktlab.app/v1/facebook/ads/campaigns' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
  "data": [
    {
      "campaign_id": "cmp_abc123",
      "campaign_name": "Campanha Promocional 2025",
      "impressions": 3200,
      "reach": 2500,
      "frequency": "1.28",
      "clicks": 145,
      "ctr": "452.3100",
      "inline_link_clicks": 60,
      "inline_link_click_ctr": "192.3076",
      "spend": "150.75",
      "cpc": "1.04",
      "cpm": "47.10",
      "actions": [
        { "value": 400, "action_type": "page_engagement" },
        { "value": 35, "action_type": "landing_page_view" },
        { "value": 400, "action_type": "post_engagement" },
        { "value": 25, "action_type": "view_content" },
        { "value": 10, "action_type": "link_click" },
        { "value": 5, "action_type": "video_view" }
      ],
      "objective": "LINK_CLICKS",
      "website_purchase_roas": "00",
      "account_id": "1235479",
      "date_start": "2025-01-01T00:00:00Z",
      "date_stop": "2025-01-07T00:00:00Z",
      "integration_id": "integration_456",
      "project_id": "project_789",
      "unit_id": "unit_123",
      "document_id": "doc_456",
      "inserted_at": "2025-01-08T12:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 500,
    "total": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}
Modificado em 2025-10-08 17:25:55
Página anterior
Ads Config [Adset Level]
Próxima página
Ads Config [Campaign Level]
Built with