Insights sobre mídia do Instagram

Representa as métricas de interação social em um objeto de mídia do Instagram.

Disponível para a API do Instagram com o Login do Facebook.

Criação

Esta operação não é compatível.

Leitura

GET /<IG_MEDIA_ID>/insights

Obtenha dados de insights sobre um objeto de mídia do Instagram.

Limitações

• Não serão disponibilizados dados de análise sobre mídias que pertencerem a um álbum de mídia do Instagram.
• As métricas de mídia de stories serão disponibilizados por apenas 24 horas, mesmo se as mídias forem arquivadas ou destacadas. Para obter os insights mais recentes sobre um story antes que ele expire, configure um webhook para o tópico Instagram e assine o campo story_insights.
• As métricas de mídia de stories com valores menores que 5 retornam o código de erro 10 com a mensagem (#10) Not enough viewers for the media to show insights.
• Para stories criados por usuários na Europa e no Japão, a métrica replies agora retorna o valor 0.
• Para os stories, as respostas de usuários na Europa e no Japão não estão incluídas nos cálculos de replies.
• Caso os dados de análise solicitados não existam ou estejam indisponíveis, a API retornará um conjunto vazio, em vez de 0 para as métricas individuais.
• Pode haver um atraso de até 48 horas nos dados usados para calcular as métricas.

Requisitos

Sintaxe da solicitação

GET https://graph.facebook.com/<API_VERSION>/<IG_MEDIA_ID>/insights
  ?metric=<LIST_OF_METRICS>
  &access_token=<ACCESS_TOKEN>

Parâmetros de caminho

Parâmetros da string de consulta

Métricas

Métricas de álbum

Métricas de fotos e vídeos

Não há compatibilidade com métricas de mídia dentro de álbuns. Em vez disso, obtenha as métricas do álbum.

Métricas do Reels

Métricas de story

Exemplo de solicitação

curl -X GET \
  'https://graph.facebook.com/v20.0/17895695668004550/insights?metric=impressions,reach&access_token=IGQVJ...'

Exemplo de resposta

{
  "data": [
    {
      "name": "impressions",
      "period": "lifetime",
      "values": [
        {
          "value": 264
        }
      ],
      "title": "Impressions",
      "description": "Total number of times the media object has been seen",
      "id": "17855590849148465/insights/impressions/lifetime"
    },
    {
      "name": "reach",
      "period": "lifetime",
      "values": [
        {
          "value": 103
        }
      ],
      "title": "Reach",
      "description": "Total number of unique accounts that have seen the media object",
      "id": "17855590849148465/insights/reach/lifetime"
    }
  ]
}

Novas métricas

Sintaxe da solicitação

GET https://graph.facebook.com/<API_VERSION>/<IG_MEDIA_ID>/insights
  ?metric=<LIST_OF_METRICS>
  &breakdown=<LIST_OF_BREAKDOWNS>
  &access_token=<ACCESS_TOKEN>

Parâmetros de caminho

Parâmetros da string de consulta

Detalhamento

Também é possível especificar um ou mais detalhamentos, e os resultados serão divididos em conjuntos menores com base no detalhamento especificado. Os valores podem ser os seguintes:

• action_type – Compatível apenas com a métrica profile_activity. Detalha os resultados por componente de interface do usuário do perfil em que os visualizadores tocaram ou clicaram depois de ver o perfil do usuário do app. Estes são os possíveis valores de resposta:

  • BIO_LINK_CLICKED
  • CALL
  • DIRECTION
  • EMAIL
  • OTHER
  • TEXT
• story_navigation_action_type – Detalha os resultados por ação de navegação executada pelo visualizador após ver a mídia.

  • TAP_BACK
  • TAP_EXIT
  • TAP_FORWARD
  • SWIPE_FORWARD

Consulte a tabela Métricas para ver as métricas compatíveis e saber quais são os detalhamentos. Se você solicitar uma métrica que não seja compatível com detalhamentos, a API retornará um erro ("An unknown error has occurred."). Por isso, tenha cuidado ao solicitar várias métricas em uma única consulta.

Métricas

Métricas de publicação

As métricas a seguir estão disponíveis em mídias de carrosséis de álbuns, imagens e vídeos do Instagram exibidas como uma publicação. O IGTV não é compatível.

Métricas de story

As seguintes métricas estão disponíveis em mídias do Instagram publicadas como um story.

Resposta

Um objeto JSON que contém os resultados da sua consulta. Os resultados podem incluir os seguintes dados, com base nas especificações da sua consulta:

{
  "data": [
    {
      "name": "{name}",
      "period": "{period}",
      "values": [
        {
          "value": {value}
        }
      ],
      "title": "{title}",
      "description": "{description}",
      "total_value": {
        "value":{value},
        "breakdowns": [
          {
            "dimension_keys": [
              "{dimension-key-1}",
              "{dimension-key-2}"
              ...
            ],
            "results": [
              {
                "dimension_values": [
                  "dimension-value-1",
                  "dimension-value-2"
                  ...
                ],
                "value": {value}
              },
              ...
            ]
          }
        ]
      },
      "id": "{id}"
    }
  ]
}

Conteúdo da resposta

Exemplo de solicitação de métrica de publicação

curl -i -X GET \
 "https://graph.facebook.com/v20.0/17932174733377207/insights?metric=profile_activity&breakdown=action_type&access_token=EAAOc..."

Exemplo de resposta de métrica de publicação

{
  "data": [
    {
      "name": "profile_activity",
      "period": "lifetime",
      "values": [
        {
          "value": 4
        }
      ],
      "title": "Profile activity",
      "description": "[IG Insights] This header is the name of a metric that appears on an educational info sheet for a particular post, story, video or promotion. This metric is the sum of all profile actions people take when they engage with this content.",
      "total_value": {
        "value": 4,
        "breakdowns": [
          {
            "dimension_keys": [
              "action_type"
            ],
            "results": [
              {
                "dimension_values": [
                  "email"
                ],
                "value": 1
              },
              {
                "dimension_values": [
                  "text"
                ],
                "value": 1
              },
              {
                "dimension_values": [
                  "direction"
                ],
                "value": 1
              },
              {
                "dimension_values": [
                  "bio_link_clicked"
                ],
                "value": 1
              }
            ]
          }
        ]
      },
      "id": "17932174733377207/insights/profile_activity/lifetime"
    }
  ]
}

Exemplo de solicitação de métrica de story

curl -i -X GET \
 "https://graph.facebook.com/v20.0/17969782069736348/insights?metric=navigation&breakdown=story_navigation_action_type&access_token=EAAOc..."

Exemplo de resposta de métrica de story

{
  "data": [
    {
      "name": "navigation",
      "period": "lifetime",
      "values": [
        {
          "value": 25
        }
      ],
      "title": "Navigation",
      "description": "This is the total number of actions taken from your story. These are made up of metrics like exited, forward, back and next story.",
      "total_value": {
        "value": 25,
        "breakdowns": [
          {
            "dimension_keys": [
              "story_navigation_action_type"
            ],
            "results": [
              {
                "dimension_values": [
                  "tap_forward"
                ],
                "value": 19
              },
              {
                "dimension_values": [
                  "tap_back"
                ],
                "value": 4
              },
              {
                "dimension_values": [
                  "tap_exit"
                ],
                "value": 1
              },
              {
                "dimension_values": [
                  "swipe_forward"
                ],
                "value": 1
              }
            ]
          }
        ]
      },
      "id": "17969782069736348/insights/navigation/lifetime"
    }
  ]
}

Atualização

Esta operação não é compatível.

Exclusão

Esta operação não é compatível.