Account Service Api1.0.0

Servers

Choose a server to use:

/api/v1/

https://account-qa.adara.com/api/v1/

https://account-prod.adara.com/api/v1/

Authentication

oauth2 oauth2

FlowclientCredentials

Token URL/core/v1.0/oauth/token

Accounts

Create customer account

POST /accounts

Auth

Request Body

Create a new account for a customer

object	object		required
name	string		required
customer_id	string		required
data_provider_id	string		optional
advertiser_id	string		optional
location	string	Default: global	required
logo	file		optional

Example Request

​x
 
curl --request POST \ --url /api/v1//accounts \ --form "file=@{file}"
Copy

Responses

200 400

object	object
active	boolean		optional
response	object		optional
id	string		required
created	integer		required
updated	integer		required
name	string		required
customer_id	string		required
data_provider_id	string		optional
advertiser_id	string		optional
location	string	Default: global	required
small_logo_url	string		optional
large_logo_url	string		optional
vertical_id	string		optional
default	boolean		optional

Example Response

200 Account created for customer

400 Bad Request

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "id": "{string}",  "created": "{integer}",  "updated": "{integer}",  "name": "{string}",  "customer_id": "{string}",  "data_provider_id": "{string}",  "advertiser_id": "{string}",  "location": "{string}",  "small_logo_url": "{string}",  "large_logo_url": "{string}",  "vertical_id": "{string}",  "default": "{boolean}" }}
Copy

Get customer Accounts

GET /accounts

Auth

Query String

customer_id	string		required
cursor_id	string		optional

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1//accounts?customer_id={customer_id}&cursor_id={cursor_id}
Copy

Responses

200 400

object	object		required
cursor_id	string	cursor to get the next sett of managers	optional
active	boolean		required
response	array		required
id	string		required
created	integer		required
updated	integer		required
name	string		required
customer_id	string		required
data_provider_id	string		optional
advertiser_id	string		optional
location	string	Default: global	required
small_logo_url	string		optional
large_logo_url	string		optional
vertical_id	string		optional
default	boolean		optional

Example Response

200 List of Accounts that exist for a Manager or Customer

400 Bad Request

xxxxxxxxxx
 
{ "cursor_id": "{string}", "active": "{boolean}", "response": [  {   "id": "{string}",   "created": "{integer}",   "updated": "{integer}",   "name": "{string}",   "customer_id": "{string}",   "data_provider_id": "{string}",   "advertiser_id": "{string}",   "location": "{string}",   "small_logo_url": "{string}",   "large_logo_url": "{string}",   "vertical_id": "{string}",   "default": "{boolean}"  } ]}
Copy

Update customer account

PUT /accounts/{account_id}

Auth

Path Params

account_id

string

account id

required

Request Body

Update a new account for a customer

object	object		required
name	string		optional
customer_id	string		required
data_provider_id	string		optional
advertiser_id	string		optional
location	string	Default: global	optional
logo	file		optional

Example Request

xxxxxxxxxx
 
curl --request PUT \ --url /api/v1//accounts/{account_id} \ --form "file=@{file}"
Copy

Responses

200 400

object	object
active	boolean		optional
response	object		optional
id	string		required
created	integer		required
updated	integer		required
name	string		required
customer_id	string		required
data_provider_id	string		optional
advertiser_id	string		optional
location	string	Default: global	required
small_logo_url	string		optional
large_logo_url	string		optional
vertical_id	string		optional
default	boolean		optional

Example Response

200 Account created for customer

400 Bad Request

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "id": "{string}",  "created": "{integer}",  "updated": "{integer}",  "name": "{string}",  "customer_id": "{string}",  "data_provider_id": "{string}",  "advertiser_id": "{string}",  "location": "{string}",  "small_logo_url": "{string}",  "large_logo_url": "{string}",  "vertical_id": "{string}",  "default": "{boolean}" }}
Copy

Customers

get list of customers

GET /customers

Get a tvs score for a particular cookie_id

Auth

Query String

cursor_id string optional

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1//customers?cursor_id={cursor_id}
Copy

Responses

200 400

object	object		required
cursor_id	string	cursor to get the next sett of managers	optional
active	boolean		required
response	array		required
id	string		required
created	integer		required
updated	integer		required
name	string		required
vertical_id	string		required
small_logo_url	string		optional
large_logo_url	string		optional

Example Response

200 Get list of customers and

400 Bad Request

xxxxxxxxxx
 
{ "cursor_id": "{string}", "active": "{boolean}", "response": [  {   "id": "{string}",   "created": "{integer}",   "updated": "{integer}",   "name": "{string}",   "vertical_id": "{string}",   "small_logo_url": "{string}",   "large_logo_url": "{string}"  } ]}
Copy

Create Customer

POST /customers

Auth

Request Body

Create a customer in Adara

object	object	required
name	string	required
vertical_id	string	required
logo	file	optional
admin_email	string	required
default_data_provider_id	string	optional
default_advertiser_id	string	optional
default_location	string	required

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1//customers \ --form "file=@{file}"
Copy

Responses

200 400

object	object
active	boolean		optional
response	object		optional
id	string		required
created	integer		required
updated	integer		required
name	string		required
vertical_id	string		required
small_logo_url	string		optional
large_logo_url	string		optional
accounts	array		optional
name	string		required
customer_id	string		required
data_provider_id	string		optional
advertiser_id	string		optional
location	string	Default: global	required
id	string		required
created	integer		required
updated	integer		required
small_logo_url	string		optional
large_logo_url	string		optional
vertical_id	string		optional
default	boolean		optional

Example Response

200 Customer successfully created

400 Bad Request

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "id": "{string}",  "created": "{integer}",  "updated": "{integer}",  "name": "{string}",  "vertical_id": "{string}",  "small_logo_url": "{string}",  "large_logo_url": "{string}",  "accounts": [   {    "name": "{string}",    "customer_id": "{string}",    "data_provider_id": "{string}",    "advertiser_id": "{string}",    "location": "{string}",    "id": "{string}",    "created": "{integer}",    "updated": "{integer}",    "small_logo_url": "{string}",    "large_logo_url": "{string}",    "vertical_id": "{string}",    "default": "{boolean}"   }  ] }}
Copy

Managers

Create a new manager

POST /managers

Auth

Request Body

Create a manager object

object	object	required
bucket_name	string	optional
small_logo_path	string	optional
large_logo_path	string	optional
name	string	required
admin_email	string	required

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1//managers \ --data '{  "bucket_name": "{string}",  "small_logo_path": "{string}",  "large_logo_path": "{string}",  "name": "{string}",  "admin_email": "{string}"}'
Copy

Responses

200 400

object	object	required
active	boolean	required
response	object	required
id	string	required
created	integer	required
updated	integer	required
name	string	required
small_logo_url	string	optional
large_logo_url	string	optional

Example Response

200 Manager successfully created

400 Bad Request

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "id": "{string}",  "created": "{integer}",  "updated": "{integer}",  "name": "{string}",  "small_logo_url": "{string}",  "large_logo_url": "{string}" }}
Copy

Get list of managers

GET /managers

Auth

Query String

cursor_id string optional

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1//managers?cursor_id={cursor_id}
Copy

Responses

200 400

object	object		required
cursor_id	string	cursor to get the next sett of managers	optional
active	boolean		required
response	array		required
id	string		required
created	integer		required
updated	integer		required
name	string		required
small_logo_url	string		optional
large_logo_url	string		optional

Example Response

200 Get list of managers and managed Accounts

400 Bad Request

xxxxxxxxxx
 
{ "cursor_id": "{string}", "active": "{boolean}", "response": [  {   "id": "{string}",   "created": "{integer}",   "updated": "{integer}",   "name": "{string}",   "small_logo_url": "{string}",   "large_logo_url": "{string}"  } ]}
Copy

Managed Accounts

Approve or Reject Manager access to customer account

PUT /managed_accounts/{managed_account_id}

Auth

Path Params

managed_account_id

string

managed account id

required

Request Body

object	object
reviewer	string	email address of the person that reviewed the access request	optional
approved	boolean		optional

Example Request

xxxxxxxxxx
 
curl --request PUT \ --url /api/v1//managed_accounts/{managed_account_id} \ --data '{  "reviewer": "{string}",  "approved": "{boolean}"}'
Copy

Responses

200 400

object	object
active	boolean	optional
response	object	optional
account_id	string	required
manager_id	string	required
customer_id	string	required
product_id	string	required
vertical	string	required
vertical_id	string	required
location	string	required
small_logo_url	string	optional
large_logo_url	string	optional
id	string	required
created	integer	required
updated	integer	required
account_name	string	optional
customer_name	string	optional

Example Response

200 Managed Account Updated

400 Bad Request

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "account_id": "{string}",  "manager_id": "{string}",  "customer_id": "{string}",  "product_id": "{string}",  "vertical": "{string}",  "vertical_id": "{string}",  "location": "{string}",  "small_logo_url": "{string}",  "large_logo_url": "{string}",  "id": "{string}",  "created": "{integer}",  "updated": "{integer}",  "account_name": "{string}",  "customer_name": "{string}" }}
Copy

Remove a managed account

DELETE /managed_accounts/{managed_account_id}

Auth

Path Params

managed_account_id

string

managed account id

required

Example Request

xxxxxxxxxx
 
curl --request DELETE \ --url /api/v1//managed_accounts/{managed_account_id}
Copy

Responses

200 400

object	object
active	boolean	optional
response	object	optional
account_id	string	required
manager_id	string	required
customer_id	string	required
product_id	string	required
vertical	string	required
vertical_id	string	required
location	string	required
small_logo_url	string	optional
large_logo_url	string	optional
id	string	required
created	integer	required
updated	integer	required
account_name	string	optional
customer_name	string	optional

Example Response

200 Managed Account Updated

400 Bad Request

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "account_id": "{string}",  "manager_id": "{string}",  "customer_id": "{string}",  "product_id": "{string}",  "vertical": "{string}",  "vertical_id": "{string}",  "location": "{string}",  "small_logo_url": "{string}",  "large_logo_url": "{string}",  "id": "{string}",  "created": "{integer}",  "updated": "{integer}",  "account_name": "{string}",  "customer_name": "{string}" }}
Copy

Request access to customer account.

POST /managed_accounts

Auth

Request Body

Add a customer account to a manager portfolio

object	object
manager_id	string	optional
customer_id	string	optional
product_id	string	optional
account_id	string	optional

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1//managed_accounts \ --data '{  "manager_id": "{string}",  "customer_id": "{string}",  "product_id": "{string}",  "account_id": "{string}"}'
Copy

Responses

200 400

object	object
active	boolean	optional
response	object	optional
account_id	string	required
manager_id	string	required
customer_id	string	required
product_id	string	required
vertical	string	required
vertical_id	string	required
location	string	required
small_logo_url	string	optional
large_logo_url	string	optional
id	string	required
created	integer	required
updated	integer	required
account_name	string	optional
customer_name	string	optional

Example Response

200 Managed Account Updated

400 Bad Request

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "account_id": "{string}",  "manager_id": "{string}",  "customer_id": "{string}",  "product_id": "{string}",  "vertical": "{string}",  "vertical_id": "{string}",  "location": "{string}",  "small_logo_url": "{string}",  "large_logo_url": "{string}",  "id": "{string}",  "created": "{integer}",  "updated": "{integer}",  "account_name": "{string}",  "customer_name": "{string}" }}
Copy

get managed accounts

GET /managed_accounts

Auth

Query String

manager_id	string	optional
product_id	string	optional
customer_id	string	optional
cursor_id	string	optional
account_id	string	optional

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1//managed_accounts?manager_id={manager_id}&product_id={product_id}&customer_id={customer_id}&cursor_id={cursor_id}&account_id={account_id}
Copy

Responses

200 400

object	object		required
cursor_id	string	cursor to get the next sett of managers	optional
active	boolean		required
response	array		required
account_id	string		required
manager_id	string		required
customer_id	string		required
product_id	string		required
vertical	string		required
vertical_id	string		required
location	string		required
small_logo_url	string		optional
large_logo_url	string		optional
id	string		required
created	integer		required
updated	integer		required
account_name	string		optional
customer_name	string		optional

Example Response

200 List of managed Accounts for a customer product

400 Bad Request

xxxxxxxxxx
 
{ "cursor_id": "{string}", "active": "{boolean}", "response": [  {   "account_id": "{string}",   "manager_id": "{string}",   "customer_id": "{string}",   "product_id": "{string}",   "vertical": "{string}",   "vertical_id": "{string}",   "location": "{string}",   "small_logo_url": "{string}",   "large_logo_url": "{string}",   "id": "{string}",   "created": "{integer}",   "updated": "{integer}",   "account_name": "{string}",   "customer_name": "{string}"  } ]}
Copy