api-referenceGET
GEThttps://analytics.flowsery.com/api/v1/campaigns

Recupere dados analiticos segmentados por parametros de campanha.

Chave API (Bearer token)

Parametros opcionais

ParametroTipoDescricao
startAtstringData/hora de início da ISO 8601. A norma são os últimos 30 dias quando omitido.
endAtstringISO 8601 end date/time. Defaults to now when omitted.
timezonestringFuso horario para agregacao (por ex., UTC, America/New_York). Recorre ao fuso horario configurado do seu site.
limitnumberNumero maximo de linhas a retornar (1-1000, padrao: 100).
offsetnumberLinhas a pular para paginacao (min 0, padrao: 0).

Parametros de filtro

ParametroTipoDescricao
filter_countrystringNome ou indicativo do país. Usar | para vários valores e! para eliminar valores.
filter_regionstringRegiao ou estado.
filter_citystringNome da cidade.
filter_devicestringTipo de dispositivo. Utilize valores de back-end como Desktop|Mobile|Tablet e! para excluir.
filter_browserstringNome do navegador. Safari inclui automaticamente Mobile Safari.
filter_osstringSistema operacional.
filter_referrerstringDominio de referencia ou nome conhecido.
filter_refstringParametro URL ref.
filter_sourcestringParametro URL source.
filter_viastringParametro URL via.
filter_utm_sourcestringFonte UTM.
filter_utm_mediumstringMeio UTM.
filter_utm_campaignstringCampanha UTM.
filter_utm_termstringTermo UTM.
filter_utm_contentstringConteudo UTM.
filter_pagestringCaminho da pagina.
filter_entry_pagestringCaminho da pagina de entrada.
filter_hostnamestringHostname/dominio.
filter_channelstringCanal de marketing.
filter_goalstringNome do objetivo.
Exemplo de requisicao (curl)
curl --request GET \
  --url https://analytics.flowsery.com/api/v1/campaigns \
  --header 'Authorization: Bearer <api-key>'
200
{
  "status": "success",
  "data": [
    {
      "campaign": {
        "utm_source": "",
        "utm_medium": "",
        "utm_campaign": "",
        "utm_term": "",
        "utm_content": "",
        "ref": "indiepage",
        "source": "",
        "via": ""
      },
      "visitors": 2150,
      "revenue": 3420,
      "renewalRevenue": 810,
      "percentage": 43.4
    },
    {
      "campaign": {
        "utm_source": "newsletter.example.com",
        "utm_medium": "email",
        "utm_campaign": "product-launch-2025",
        "utm_term": "",
        "utm_content": "",
        "ref": "",
        "source": "",
        "via": ""
      },
      "visitors": 1840,
      "revenue": 2890,
      "renewalRevenue": 540,
      "percentage": 37.1
    },
    {
      "campaign": {
        "utm_source": "",
        "utm_medium": "",
        "utm_campaign": "",
        "utm_term": "",
        "utm_content": "",
        "ref": "",
        "source": "",
        "via": "partner"
      },
      "visitors": 920,
      "revenue": 1450,
      "renewalRevenue": 210,
      "percentage": 18.5
    }
  ],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 138
  }
}