Account Service Api 1.0.0

Server

/api/v1/

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

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

Authentication

oauth2 oauth2

FlowClient Credentials

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

Accounts

/accounts/{account_id}

Create customer account

Auth

Required Scopes:post:accounts

Request Body

Create a new account for a customer

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

POST /accounts

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1//accounts' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'
Copy

Responses

200

Account created for customer

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

400

Bad Request

Response

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

Auth

Required Scopes:get:accounts

Query String

customer_id	string
cursor_id	string

GET /accounts

xxxxxxxxxx
 
curl --get \ --url '/api/v1//accounts' \ --header 'Authorization: Bearer {token}' \ --data customer_id={customer_id} \ --data cursor_id={cursor_id}
Copy

Responses

200

List of Accounts that exist for a Manager or Customer

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

400

Bad Request

Response

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

Auth

Required Scopes:put:accounts

Path Params

account_id

string

account id

Request Body

Update a new account for a customer

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

PUT /accounts/{account_id}

xxxxxxxxxx
 
curl --request PUT \ --url '/api/v1//accounts/%7Baccount_id%7D' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'
Copy

Responses

200

Account created for customer

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

400

Bad Request

Response

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 a tvs score for a particular cookie_id

Auth

Required Scopes:get:customers

Query String

cursor_id string

GET /customers

xxxxxxxxxx
 
curl --get \ --url '/api/v1//customers' \ --header 'Authorization: Bearer {token}' \ --data cursor_id={cursor_id}
Copy

Responses

200

Get list of customers and

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

400

Bad Request

Response

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

Auth

Required Scopes:post:customers

Request Body

Create a customer in Adara

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

POST /customers

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1//customers' \ --header 'Authorization: Bearer {token}' \ --form 'file=@{file}'
Copy

Responses

200

Customer successfully created

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

400

Bad Request

Response

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

Auth

Required Scopes:post:managers

Request Body

Create a manager object

object	object
bucket_name	string
small_logo_path	string
large_logo_path	string
name	string
admin_email	string

POST /managers

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

Responses

200

Manager successfully created

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

400

Bad Request

Response

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

Auth

Required Scopes:get:managers

Query String

cursor_id string

GET /managers

xxxxxxxxxx
 
curl --get \ --url '/api/v1//managers' \ --header 'Authorization: Bearer {token}' \ --data cursor_id={cursor_id}
Copy

Responses

200

Get list of managers and managed Accounts

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

400

Bad Request

Response

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

PUT

/managed_accounts/{managed_account_id}

DELETE

/managed_accounts/{managed_account_id}

Approve or Reject Manager access to customer account

Auth

Required Scopes:put:managed_accounts

Path Params

managed_account_id

string

managed account id

Request Body

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

PUT /managed_accounts/{managed_account_id}

xxxxxxxxxx
 
curl --request PUT \ --url '/api/v1//managed_accounts/%7Bmanaged_account_id%7D' \ --header 'Authorization: Bearer {token}' \ --data '{  "reviewer": "{string}",  "approved": "{boolean}"}'
Copy

Responses

200

Managed Account Updated

object	object
active	boolean
response	object
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

400

Bad Request

Response

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

Auth

Required Scopes:delete:managed_accounts

Path Params

managed_account_id

string

managed account id

DELETE /managed_accounts/{managed_account_id}

xxxxxxxxxx
 
curl --request DELETE \ --url '/api/v1//managed_accounts/%7Bmanaged_account_id%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Managed Account Updated

object	object
active	boolean
response	object
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

400

Bad Request

Response

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.

Auth

Required Scopes:post:managed_accounts

Request Body

Add a customer account to a manager portfolio

object	object
manager_id	string
customer_id	string
product_id	string
account_id	string

POST /managed_accounts

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

Responses

200

Managed Account Updated

object	object
active	boolean
response	object
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

400

Bad Request

Response

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

Auth

Required Scopes:get:managed_accounts

Query String

manager_id	string
product_id	string
customer_id	string
cursor_id	string
account_id	string

GET /managed_accounts

xxxxxxxxxx
 
curl --get \ --url '/api/v1//managed_accounts' \ --header 'Authorization: Bearer {token}' \ --data manager_id={manager_id} \ --data product_id={product_id} \ --data customer_id={customer_id} \ --data cursor_id={cursor_id} \ --data account_id={account_id}
Copy

Responses

200

List of managed Accounts for a customer product

object	object
cursor_id	string	cursor to get the next sett of managers
active	boolean
response	array
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

400

Bad Request

Response

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