carat-api-aws

Documentation

• Documentation

Section

• Overview Page
• User Analysis
• Product Page
• Referral Page
• Crowd Analysis

Usage

• general parameters

  • domain
  • group
  • from
  • to
  • device

• stage

  • dev
  • prod

• domain

  • nissan
  • mitsubishi_young
  • mitsubishi

• {from}/{to}

  • date format: YYYY-MM-DD

Cluster

clustering

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}
example	clustering

clusters-clients-inserting

Key	Description
method	POST
endpoint	https://can-not-access-from-exapmle
parameters	``
example	clusters-clients-inserting

Overview Page

general

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	general

product-ranking

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	product-ranking

book

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	book

session-per-time

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{referrerCategory}/{from}/{to}
explain	referrerCategory : {0 : all, 1 : organic, 2 : paid}
example	session-per-time

session-per-hour

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	session-per-hour

weekly-compare

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}
example	weekly-compare

period-compare

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	period-compare

media-compare

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{group}/{from}/{to}
example	media-compare

User Analysis

browser-distribution

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	browser-distribution

language-distribution

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	language-distribution

operating-system-distribution

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	operating-system-distribution

returning-distribution

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	returning-distribution

search-term-distribution

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	search-term-distribution

user-sankey-diagram

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	user-sankey-diagram

exit-page-table

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	exit-page-table

location-distribution

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	location-distribution

Product Page

product-general

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	product-general

product-single-general

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{productId}/{from}/{to}
example	product-single-general

product-page-scroll-table

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{productId}/{from}/{to}
example	product-page-scroll-table

related-product-table

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{productId}/{from}/{to}
example	related-product-table

product-referral-analysis-table

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{productId}/{from}/{to}
example	product-referral-analysis-table

product-list

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}
example	product-list

Referral Page

advertising-media-distribution

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	advertising-media-distribution

visitor-trends

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	visitor-trends

visitor-trends-media-list

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	visitor-trends-media-list

visitor-trends-single

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{mediaId}/{from}/{to}
example	visitor-trends-single

media-info-table

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	media-info-table

media-trends-table

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	media-trends-table

customer-conversion-dot-table

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}
example	customer-conversion-dot-table

media-campaign-product

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{from}/{to}
example	media-campaign-product

media-conversion-table

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}
example	media-conversion-table

related-media-general

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	related-media-general

related-media-single

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}/{from}/{to}
example	related-media-single

Crowd Analysis

crowd-analysis-total

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}
example	crowd-analysis-total

crowd-analysis-last-access

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}
example	crowd-analysis-last-access

crowd-analysis-session-times

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}
example	crowd-analysis-session-times

crowd-analysis-staying-duration

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}
example	crowd-analysis-staying-duration

crowd-analysis-first-media

Key	Description
method	GET
endpoint	https://can-not-access-from-exapmle
parameters	{domain}/{group}
example	crowd-analysis-first-media