Docs
Search docs...⌘K

Projects

API only
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.

Allowed values:privateshared
Default:private
protocolstringRequired

The protocol of the project's target.

Allowed values:bothhttphttps
urlstringRequired

The URL of the project's target.

modestringRequired

The scope of the target.

Allowed values:exactprefixdomainsubdomains
project_namestringRequired

The name of the project.

Responses

projectsarray<object>
accessstring

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

keyword_countinteger

The number of keywords in the project.

modestring

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

owned_bystring or null

The email of the project owner.

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.

protocolstring

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

urlstring (url)

The URL of the project's target.

verifiedboolean

Whether the project is verified.

web_analytics_data_keystring

Web Analytics Data Key.