AdnovaDocs
Analytics

List naming conventions

Returns the naming convention configured for this ad account: a separator and an ordered list of properties that describe what each position in an ad name represents (e.g. campaign objective, audience, month). Use the property ids when filtering or grouping Fetch ad insights by a naming-convention position — pass field: namingConvention and namingConventionId: <id>. If no convention has been configured, separator is "" and properties is empty.

GET
/naming_conventions

Authentication

authentication
api-key<token>

Create an API key from the Adnova dashboard (Account integrations). Pass the key value in the api-key request header on every call.

In: header

Query Parameters

platform*string

Ad platform the account lives on. Must match the platform field on the ad account row from List ad accounts.

Value in"facebook" | "tiktok"
adAccountId*string

AdAccountId required to map the platform account. Read id from the List Ad Accounts response. Pass it as adAccountId to Analytics endpoints.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.adnova.ai/analytics/v1/naming_conventions?platform=facebook&adAccountId=string"
{
  "platform": "facebook",
  "adAccountId": "string",
  "namingConvention": {
    "separator": "string",
    "properties": [
      {
        "id": "string",
        "name": "string",
        "identifier": "string",
        "values": [
          "string"
        ],
        "position": 0
      }
    ]
  }
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}