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: /api/v1/company/website-traffic

Authentication requirements

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

Request

Request Parameters

Header Parameters

string
required
Your API key.

URL Parameters

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:
object
Container object holding the company’s website traffic data. See Website Traffic Object Fields below.
float
Credits consumed by the request.

Website Traffic Object Fields

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

Engagements Object

string
Total estimated visits for the month. Returned as a numeric string.
string
Share of visits that left after viewing a single page, expressed as a decimal from 0 to 1. Returned as a numeric string.
string
Average number of pages viewed per visit. Returned as a numeric string.
string
Average time spent on site per visit, in seconds. Returned as a numeric string.
string
Month of the reported engagement metrics (112). Returned as a numeric string.
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.
float
Share of traffic arriving via direct navigation (typed URL or bookmark).
float
Share of traffic arriving via unpaid search results.
float
Share of traffic arriving via paid search ads.
float
Share of traffic arriving via unpaid social media.
float
Share of traffic arriving via paid social media ads.
float
Share of traffic arriving via referral links from other websites.
float
Share of traffic arriving via email links.
float
Share of traffic arriving via display advertising.
float
Share of traffic arriving via affiliate links.
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>