Get a segment
Index details or traffic for the pages under one directory of your website, a page of Bing's list at a time.
https://api.rankparse.com/v1/bing/segmentFreeAPI key + connected Bing accountThe pages under one directory of your website (a segment such as /blog/), with either their traffic or their index details. This is the Bing counterpart of a page segment in Search Console. Bing pages the list itself with page.
Bing's payload for this method is passed through with its keys in snake_case and its dates as ISO timestamps. The fields below are the ones Microsoft documents; anything else Bing adds appears as well. The index view calls Bing's GetChildrenUrlInfo, which also accepts a filter this route does not send; if Bing rejects the call you get 400 bing_request_rejected, and view=traffic is the one to rely on.
Query parameters
sitestringrequiredThe website, as returned by List properties, or a bare host or URL such as example.com, which is matched to a website you have verified. A website with no match returns 404 bing_site_not_found with valid_properties. Missing returns 400 missing_site.
pathstringrequiredThe directory URL, for example https://example.com/blog/. Missing returns 400 missing_path.
viewstringdefault traffictraffic (clicks and impressions per page) or index (crawl and index details per page). Anything else returns 400 invalid_view.
pageintegerdefault 0Bing's own page number of the list. Ask for the next number when a page is full. Negative or non-integer returns 400 invalid_param.
startRowintegerdefault 0Offset into the rows, to read past the first page. Use next_start_row from a response that says has_more.
rowLimitintegerdefault 100Rows to return, at most 1000.
Response
sourcestringbing.
sitestringThe website that was read.
requested_sitestringPresent only when your site was matched to a different website; site then holds the one used.
pathstringThe directory you asked about.
viewstringtraffic or index.
pageintegerThe Bing page number that was read.
rowsarrayOne object per page or directory, as Bing reports it with snake_case keys. For traffic: url, clicks, impressions, is_page. For index: the fields of Get URL info.
row_countintegerRows in this response.
total_matchedintegerRows available before startRow and rowLimit.
has_morebooleantrue when more rows follow this page.
next_start_rowintegerPresent when has_more is true: pass it as startRow for the next page.
notestringWhat this data does and does not cover.
Behavior and limits
- Credits: 0. Counts toward the daily cap of 300 live Bing reads per workspace.
- Two kinds of paging:
pagemoves through Bing's list,startRowandrowLimittrim what one Bing page returned.
Errors
See the shared errors. Parameter errors are 400 with the codes named above.
Related
MCP tool: get_bing_segment.