Docs
Search docs...⌘K

Projects

POST/v3/management/projects

Requests to this endpoint are free and do not consume any API units.

Query parameters

outputstring

The output format.

Allowed values:jsoncsvxmlphp

Request body

owned_bystring

The email of the project owner. If not provided, the project is assigned to the Workspace owner.

accessstring

The access type of the project.

privateshared
protocolstring

The protocol of the project's target.

bothhttphttps
urlstring

The URL of the project's target.

modestring

The scope of the target.

exactprefixdomainsubdomains
project_namestring

The name of the project.

Responses

projectsarray
project_idstring

The unique identifier of the project. You can find it in the URL of your Rank Tracker project in Ahrefs: https://app.ahrefs.com/rank-tracker/overview/#project_id#.

project_namestring

The project name.

urlstring

The URL of the project's target.

modestring

The scope of the target. Possible values: exact, prefix, domain, subdomains.

protocolstring

The protocol of the target. Possible values: both, http, https.

accessstring

The access level of the project. Possible values: private, shared.

owned_bystring or null

The email of the project owner.

keyword_countinteger

The number of keywords in the project.

web_analytics_data_keystring

Web Analytics Data Key.