For the complete documentation index, see llms.txt. This page is also available as Markdown.

Audience Feature Folders

Operations related to Audience Feature Folders for organizing Audience Features within a Datamart.

Fetch audience feature folders

get
/datamarts/{datamart_id}/audience_feature_folders
Path parameters
datamart_idstringRequired
Query parameters
namestringOptional

The name of the audience feature folder

audience_features_idsstring[]Optional

The audience features store in the folder

parentIdstringOptional

The parent folder

childrenIdsstring[]Optional

The children folders

first_resultinteger · int32Optional

Offset from which the search must be performed

max_resultsinteger · int32Optional

Number of maximum items that may be returned by this search

order_bystring[]Optional

Fields used to order the result

Responses
200

Success !

application/json
countintegerRequired
totalintegerRequired
first_resultintegerRequired
max_resultsintegerRequired
statusstring · enumRequiredPossible values:
get/datamarts/{datamart_id}/audience_feature_folders
GET /v1/datamarts/{datamart_id}/audience_feature_folders HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "count": 1,
  "data": [
    {
      "parent_id": "text",
      "name": "text",
      "datamart_id": "text",
      "audience_features_ids": [
        "text"
      ],
      "id": "text",
      "children_ids": [
        "text"
      ]
    }
  ],
  "total": 1,
  "first_result": 1,
  "max_results": 1,
  "status": "ok"
}

Create a audience feature folder

post
/datamarts/{datamart_id}/audience_feature_folders
Path parameters
datamart_idstringRequired
Body
parent_idstringOptional
namestringRequired
datamart_idstringRequired
audience_features_idsstring[]Optional
idstringRead-onlyRequired
children_idsstring[]Optional
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/datamarts/{datamart_id}/audience_feature_folders
POST /v1/datamarts/{datamart_id}/audience_feature_folders HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "parent_id": "text",
  "name": "text",
  "datamart_id": "text",
  "audience_features_ids": [
    "text"
  ],
  "children_ids": [
    "text"
  ]
}
{
  "status": "ok",
  "data": {
    "parent_id": "text",
    "name": "text",
    "datamart_id": "text",
    "audience_features_ids": [
      "text"
    ],
    "id": "text",
    "children_ids": [
      "text"
    ]
  }
}

Get audience feature folder by id

get
/datamarts/{datamart_id}/audience_feature_folders/{audience_feature_folder_id}
Path parameters
datamart_idstringRequired
audience_feature_folder_idstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/datamarts/{datamart_id}/audience_feature_folders/{audience_feature_folder_id}
GET /v1/datamarts/{datamart_id}/audience_feature_folders/{audience_feature_folder_id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "parent_id": "text",
    "name": "text",
    "datamart_id": "text",
    "audience_features_ids": [
      "text"
    ],
    "id": "text",
    "children_ids": [
      "text"
    ]
  }
}

Update an audience feature folder

put
/datamarts/{datamart_id}/audience_feature_folders/{audience_feature_folder_id}
Path parameters
datamart_idstringRequired
audience_feature_folder_idstringRequired
Body
parent_idstringOptional
namestringRequired
datamart_idstringRequired
audience_features_idsstring[]Optional
idstringRead-onlyRequired
children_idsstring[]Optional
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/datamarts/{datamart_id}/audience_feature_folders/{audience_feature_folder_id}
PUT /v1/datamarts/{datamart_id}/audience_feature_folders/{audience_feature_folder_id} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "parent_id": "text",
  "name": "text",
  "datamart_id": "text",
  "audience_features_ids": [
    "text"
  ],
  "children_ids": [
    "text"
  ]
}
{
  "status": "ok",
  "data": {
    "parent_id": "text",
    "name": "text",
    "datamart_id": "text",
    "audience_features_ids": [
      "text"
    ],
    "id": "text",
    "children_ids": [
      "text"
    ]
  }
}

Delete a audience feature folder

delete
/datamarts/{datamart_id}/audience_feature_folders/{audience_feature_folder_id}
Path parameters
datamart_idstringRequired
audience_feature_folder_idstringRequired
Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/datamarts/{datamart_id}/audience_feature_folders/{audience_feature_folder_id}
DELETE /v1/datamarts/{datamart_id}/audience_feature_folders/{audience_feature_folder_id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

Last updated

Was this helpful?