Ler uma campanha

Obtenha uma campanha identificada por um campaignGuid específico com as propriedades fornecidas. Junto com as informações da campanha, também retorna informações sobre os ativos. Dependendo dos parâmetros de consulta usados, também pode ser utilizado para retornar informações sobre as métricas dos ativos correspondentes. As métricas estão disponíveis somente se startDate e endDate forem especificadas.

GET /marketing/v3/campaigns/{campaignGuid}

Ler uma campanha

cURL

curl --request GET \
  --url https://api.hubapi.com/marketing/v3/campaigns/{campaignGuid} \
  --header 'Authorization: Bearer <token>'

200

{
  "assets": {},
  "businessUnits": [
    {
      "id": 123
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "properties": {},
  "updatedAt": "2023-11-07T05:31:56Z"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.

Marketing Hub -Professional

Sales Hub -Grátis

Service Hub -Grátis

Content Hub -Grátis

Escopos Necessários

Autorizações

oauth2private_apps

Authorization · string · header · obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de caminho

campaignGuid · string · obrigatório

Parâmetros de consulta

endDate · string

properties · string[]

startDate · string

Resposta

200

application/json

successful operation

assets · object · obrigatório

Contém os recursos associados à campanha, cada um representado como um conjunto de ativos da campanha.

Show child attributes

businessUnits · object[] · obrigatório

Show child attributes

createdAt · string<date-time> · obrigatório

A data e a hora de criação da campanha, formatadas como uma string de data e hora.

id · string · obrigatório

O identificador exclusivo da campanha.

properties · object · obrigatório

Um mapa de pares chave-valor representando as propriedades da campanha.

Show child attributes

updatedAt · string<date-time> · obrigatório

A data e a hora da última atualização da campanha, formatadas como uma string de data e hora.