Introdução

Permite buscar as informações mensais de desempenho da loja dentro da plataforma Yourviews.

As informações retornadas são idênticas às enviadas mensalmente à todos os administradores ativos em sua loja.


O resultado é no seguinte formato:

{
    "HasErrors": false, //Se houve algum erro na chamada
    "Element": object , //Elemento retornado pela chamada (vide abaixo Estrutura de retorno)
    "ErrorList": [], //Lista de erros, se houver
    "Total": 0, //Total de itens retornados pela busca
    "CurrentPage": 0 //Pagina atual buscada
}


Estrutura de retorno


RelatórioEstrutura principal de retorno
Tipo de Dado
DateFrom
mês/ano do inicio da comparação do relatóriotexto
DateTo
mês/ano do fim da comparação do relatório
texto
ReviewConversionRate
Taxa de conversão (%) emails disparados / avaliações recebidas do mês solicitado.decimal
ReviewConversionRateEvolution
Taxa de evolução da conversão de emails/avaliações em relação ao mês anterior a data solicitada.decimal
CountSales
Quantidade de vendas de vendas  provenientes de nossa ferramenta realizadas no mês solicitado.inteiro
CountSalesEvolution
Taxa de evolução da quantidade de vendas  provenientes de nossa ferramenta em relação ao mês anterior a data solicitada.
decimal
ValueSales
Valores gerados em vendas pela Yourviews no mês solicitado.decimal
ValueSalesEvolution
Taxa de evolução dos valores de vendas gerados em relação ao mês anterior a data solicitada.decimal
TotalReview
Quantidade total de avaliações recebidas no mês solicitado.inteiro
ReviewEvolution
Taxa de evolução da quantidade de avaliações recebidas em relação ao mês anterior a data solicitadadecimal
TotalReviewEngagement
Quantidade total de curtidas recebidas em avaliações no mês solicitado.inteiro
ReviewEngagementEvolution
Taxa de evolução da quantidade de curtidas recebidas em relação ao mês anterior da data solicitada.decimal
TotalReadReview
Quantidade total de leitura de avaliações realizadas no mês solicitado.inteiro
ReadReviewEvolution
Taxa de evolução da quantidade de leituras de avaliações recebidas em relação ao mês anterior da data solicitada.
decimal
TotalStoreReview
Quantidade total de avaliações de loja recebidas no mês solicitado.inteiro
StoreReviewEvolution
Taxa de evolução da quantidade de avaliações de loja recebidas em relação ao mês anterior da data solicitada.
decimal
StoreReviewAverage
Média geral da nota recebida nas avaliações de loja.decimal
StoreReviewAverageEvolution
Taxa de evolução da média de nota nas avaliações de loja em relação ao mês anterior da data solicitada.
decimal
StoreReviewNegativeRate
Porcentagem de avaliações de loja negativas recebidas no mês solicitado.decimal
StoreReviewNegativeRateEvolution
Taxa de evolução de avaliações de loja negativas recebidas em relação ao mês anterior da data solicitada.decimal
StoreReviewPositiveRate
Porcentagem de avaliações de loja positivas recebidas no mês solicitado.
decimal
StoreReviewPositiveRateEvolution
Taxa de evolução de avaliações de loja positivas recebidas em relação ao mês anterior da data solicitada.
decimal
TotalQA
Quantidade total de perguntas recebidas no mês solicitado.inteiro
TotalQAEvolution
Taxa de evolução na quantidade total de perguntas recebidas em relação ao mês anterior da data solicitada.decimal
TotalQAAnswered
Total de perguntas respondidas no mês solicitado.inteiro
TotalQAAnsweredEvolution
Taxa de evolução na quantidade total de perguntas respondidas em relação ao mês anterior ao da data solicitada.decimal
QAAtendenceTime
Tempo de resposta média (em horas), para perguntas realizadas no mês solicitado.decimal
QAAtendenceTimeEvolution
Taxa de evolução no tempo de resposta média, em relação ao mês anterior ao da data solicitada.
decimal
QAResponsePercentage
Porcentagem de perguntas respondida no mês solicitado.decimal
TotalQAEngagementPositive
Quantidade total de engajamentos positivos (like) em perguntas e respostas no mês solicitado.inteiro
TotalQAEngagementNegative
Quantidade total de engajamentos negativos (dislike) em perguntas e respostas no mês solicitado.
inteiro
ChartUrl
Url para um gráfico gerado informando a evolução na quantidade de avaliações recebidas nos últimos 6 meses.texto
BestReviewStoreTagsCount
Quantidade total de tags na listagem de melhores tags nas avaliações de loja.inteiro
BestReviewProductTagsCount
Quantidade total de tags na listagem de melhores tags nas avaliações de produto.
inteiro
BestReviewProductTags[]
Lista das tags mais utilizadas em avaliações de produto no mês solicitado.Lista de Tag
TagDefinição do objeto Tag

IdTag
Identificador interno da tag na Yourviews.
inteiro
NameNome da tag.
texto
TotalQuantidade total de vezes em que a tag foi atribuída em avaliações de produto.
inteiro
BestReviewStoreTags[]
Lista das tags mais utilizadas em avaliações de loja no mês solicitado.
Lista de Tag
Tag
Definição do objeto Tag
IdTagIdentificador interno da tag na Yourviews.inteiro
NameNome da tag.texto
TotalQuantidade total de vezes em que a tag foi atribuída em avaliações de loja.inteiro
StoreInfoDefinição do objeto StoreInfo

Name
Nome da loja.texto
Alias
Apelido da loja.texto
Avatar
Url da imagem utilizada como logo da loja.texto
IdStore
Identificador interno na Yourviews da Loja.inteiro



Exemplo de retorno


{
    "HasErrors": false,
    "Element": {
        "StoreInfo": {
            "Name": "Teste",
            "Alias": "Teste",
            "Avatar": "http://teste.jpg",
            "IdStore": "1308"
        },
        "DateFrom": "abril/2018",
        "DateTo": "maio/2018",
        "ReviewConversionRate": 15.17,
        "ReviewConversionRateEvolution": 3.17,
        "CountSales": 0,
        "CountSalesEvolution": 0,
        "ValueSales": 0,
        "ValueSalesEvolution": 0,
        "TotalReview": 1247,
        "ReviewEvolution": -3,
        "TotalReviewEngagement": 639,
        "ReviewEngagementEvolution": -0.16,
        "TotalReadReview": 447178,
        "ReadReviewEvolution": -10.66,
        "TotalStoreReview": 931,
        "StoreReviewEvolution": -4.22,
        "StoreReviewAverage": 4.43,
        "StoreReviewAverageEvolution": -2.08,
        "StoreReviewNegativeRate": 6.98,
        "StoreReviewNegativeRateEvolution": 41.38,
        "StoreReviewPositiveRate": 93.02,
        "StoreReviewPositiveRateEvolution": -2.15,
        "TotalQA": 889,
        "TotalQAEvolution": -17,
        "TotalQAAnswered": 85.83,
        "TotalQAAnsweredEvolution": -4.1,
        "QAAtendenceTime": 102.7,
        "QAAtendenceTimeEvolution": 45.26,
        "QAResponsePercentage": -90.35,
        "TotalQAEngagementPositive": 572,
        "TotalQAEngagementNegative": 344,
        "ChartUrl": "http://chart.apis.google.com/chart?cht=bvs&chxl=0:|janeiro|fevereiro|março|abril|maio|junho&chs=500x200&chco=1A5276|1F618D|2471A3|2980B9|5499C7|A9CCE3&chxt=x,y&chxr=1,0,2043&chdl=janeiro|fevereiro|março|abril|maio|junho&chbh=a&chtt=Total de Avaliações Mensais&chts=000000,20&chd=t:32,100,99,62,61,62",
        "BestReviewStoreTags": [
            {
                "IdTag": 9649,
                "Name": "Promotor",
                "Total": 720
            },
            {
                "IdTag": 9687,
                "Name": "Detrator",
                "Total": 130
            },
            {
                "IdTag": 9652,
                "Name": "Neutro",
                "Total": 94
            }
        ],
        "BestReviewStoreTagsCount": 3,
        "BestReviewProductTags": [
            {
                "IdTag": 9533,
                "Name": "Má Qualidade",
                "Total": 95
            },
            {
                "IdTag": 9532,
                "Name": "Insatisfeito",
                "Total": 88
            },
            {
                "IdTag": 9534,
                "Name": "Atraso",
                "Total": 46
            }
        ],
        "BestReviewProductTagsCount": 3
    },
    "ErrorList": [],
    "Total": 0,
    "CurrentPage": 0
}


Buscar relatório:

Endpoint: GET /MonthlyReport/{DataDeReferencia}

Busca as informações de relatório mensal do mês passado no parâmetro {DataDeReferencia}.


O formato da data no parâmetro DataDeReferencia segue o padrão AAAA-mm-dd, sendo AAAA o ano, mm o mês e dd o dia de referência.

Ex: 2018-06-07 (Seis de Julho de dois mil e dezoito).


A comparação do relatório será feita sempre em relação ao mês anterior ao da data solicitada.

Desta forma todos os valores de evolução são comparações com os valores obtidos no mês anterior.