Management

Add Brand Radar prompts

Changed on

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

post/management/brand-radar-prompts

Request

  • Base URL
    https://api.ahrefs.com/v3
  • URL
    https://api.ahrefs.com/v3/management/brand-radar-prompts
  • Auth
    HTTP bearer

Query parameters

report_idstring required

The ID of the report to use. You can find it in the URL of your Brand Radar report in Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

output'json' | 'php' | 'xml'

The output format.

Request body

promptsstring[] required

A list of custom prompts to add. They must be valid utf8 and less than 400 characters.

countriesstring[] required

A list of two-letter country codes (ISO 3166-1 alpha-2).

tagsstring[]

A list of tags to assign to the prompts. A tag the report does not have yet is created.

Response

OK

Changes

    • breaking

      removed the enum value csv from the query request parameter output

    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: application/xml)