Traffic by URL mask

The SerpstatUrlProcedure.getSummaryTraffic method returnes information about traffic and keywords number by URL mask.

Use case: Get information about traffic to all subpages of a website that match a specific URL mask to analyze the effectiveness of specific sections or content on the site.
1. Use the SerpstatUrlProcedure.getSummaryTraffic method, specifying the domain and URL mask.
2. Get a response with detailed information about traffic to all relevant subpages.
3. Analyze the data to make decisions about further optimization of the site or its individual sections.

General request parameters and instructions for using Serpstat API

Search databases available

Request parameters

Parameter

Description

Type

Optional

Default value

Value Options

id

A request id: the response contains the same id.

int/string

no

Text or number value

method

API method name

string

no

SerpstatUrlProcedure.getSummaryTraffic

params

The object with parameters {...}, it lists all the following parameters and arrays [...]

no

se

ID of the search base to be searched.

string

no

For example: g_us (all search bases list)

domain

Domain to be searched

string

no

ebay.com (Any domain name)

urlContains

Searched part of URL

string

no

/mobile/ (part of URL you want to search)

output_data

Output data value

string

yes

"traffic",
"keywords"

"traffic","keywords". Both options enable by default, choose one to spend less credits.


Response parameters

Parameter

Description

id

Response id corresponds the request id

result

Contains the answer

urls

Number of URLs to be searched

traffic

Organic traffic found by URL mask

keywords

Number of keywords found by URL mask

summary_info

Object with data

left_lines

API credits remaining

Credits: When calculating used credits any API queries are taken into account in accordance with you pricing plan. This method charges 2000 API limits per request. 
When using the optional output_data parameter — 1000 limits are charged for each listed result in the request.

Example PHP Python
Request data:
{
 "id": 1,
 "method": "SerpstatUrlProcedure.getSummaryTraffic",
 "params" : {
     "se" : "g_us",
     "domain" : "ebay.com",
     "urlContains" : "/mobile/",
     "output_data": "traffic"
 }
}

Response data:
{
    "id": "1",
    "result": {
        "urls": 124,
        "traffic": 1712,
        "summary_info": {
            "left_lines": 936913
        }
    }
}

Share this article with your friends

Are you sure?

Introducing Serpstat

Find out about the main features of the service in a convenient way for you!

Please send a request, and our specialist will offer you education options: a personal demonstration, a trial period, or materials for self-study and increasing expertise — everything for a comfortable start to work with Serpstat.

Name

Email

Phone

We are glad of your comment
I agree to Serpstat`s Privacy Policy.

Thank you, we have saved your new mailing settings.

Open support chat