Skip to main content
GET
Website Traffic

Overview

The Website Traffic API returns a company’s website traffic signals, including visitor engagement metrics (bounce rate, pages per visit, time on site, total visits) for the most recent month, a historical series of estimated monthly visits, and a breakdown of traffic by acquisition source (organic search, paid search, social, direct, referral, and more). Results are returned in the API response.

Endpoint Details

  • Method: GET
  • Endpoint: /v1/company/website-traffic

Authentication requirements

  • Include a valid API key in the x-api-key request header.

Request

Request Parameters

Header Parameters

x-api-key
string
required
Your API key.

URL Parameters

company
string
required
Company website (e.g. canva.com) or a company UUID (e.g. 00000l1). The UUID can be obtained from the Company Search API.

Example Request

Response

Successful Response Fields

Returns a JSON object with the following structure:
data
object
Container object holding the company’s website traffic data. See Website Traffic Object Fields below.
credits_consumed
float
Credits consumed by the request.

Website Traffic Object Fields

uuid
string
Akta UUID of the company.
engagements
object
Visitor engagement metrics for the most recent reported month. See Engagements Object below.
estimated_monthly_visits
object
Historical series of estimated total monthly visits. Keys are month-start dates formatted as YYYY-MM-DD, values are estimated visit counts (integer).
traffic_sources
object
Breakdown of traffic by acquisition channel for the most recent reported month. See Traffic Sources Object below.

Engagements Object

visits
string
Total estimated visits for the month. Returned as a numeric string.
bounce_rate
string
Share of visits that left after viewing a single page, expressed as a decimal from 0 to 1. Returned as a numeric string.
page_per_visit
string
Average number of pages viewed per visit. Returned as a numeric string.
time_on_site
string
Average time spent on site per visit, in seconds. Returned as a numeric string.
month
string
Month of the reported engagement metrics (112). Returned as a numeric string.
year
string
Year of the reported engagement metrics. Returned as a numeric string.

Traffic Sources Object

Each field represents the share of total traffic attributed to that channel, expressed as a decimal from 0 to 1. Shares across all fields sum to approximately 1.
direct
float
Share of traffic arriving via direct navigation (typed URL or bookmark).
search_organic
float
Share of traffic arriving via unpaid search results.
search_paid
float
Share of traffic arriving via paid search ads.
social_organic
float
Share of traffic arriving via unpaid social media.
social_paid
float
Share of traffic arriving via paid social media ads.
referrals
float
Share of traffic arriving via referral links from other websites.
mail
float
Share of traffic arriving via email links.
display_ads
float
Share of traffic arriving via display advertising.
affiliate
float
Share of traffic arriving via affiliate links.
gen_ai
float
Share of traffic arriving via generative AI tools and chat assistants (e.g. answer citations, AI-generated links).

Authorizations

x-api-key
string
header
required

API key obtained from your Akta account.

Query Parameters

company
string
required

Company website (e.g. 'canva.com') or a company UUID. The UUID can be obtained from the Company Search API.

Response

Website traffic data returned

data
object
credits_consumed
number<float>