Skip to main content

Account

Account configuration collection manages system-wide account settings including naming, descriptions, timezone settings, and redirection URLs for multi-tenant system operations.

The account Object

Account collection stores fundamental account configuration data that defines account identity, regional settings, and default redirection behavior within the TrackVision system.

Field NameTypeDescription
iduuidPrimary key. Unique identifier for the account (UUID format).
user_createdobjectUnique identifier of the user who created the account record.
date_createddatetimeTimestamp in ISO8601 when the account record was created.
user_updatedobjectUnique identifier of the user who last updated the account record.
date_updateddatetimeTimestamp in ISO8601 when the account record was last updated.
account_namestringDisplay name for the account used in system interfaces and reporting.
account_descriptionstringOptional detailed description of the account and its purpose.
timezonestringDefault timezone setting for the account, references timezone collection.
account_redirection_urlstring"Last resort" default URL for Digital Link redirections when no other more specific redirection rules apply.

List Accounts

List existing accounts.

GET /items/account

Query Parameters

Supports all global query parameters.

Returns

An array of up to limit account objects. If no items are available, data will be an empty array.


Retrieve an Account

Retrieve a specific account by ID.

GET /items/account/:id

Returns

Returns an account object if a valid primary key was provided.


Create an Account

Create a new account.

POST /items/account

{
"account_name": "TrackVision Enterprise",
"account_description": "Enterprise account for comprehensive TV analytics",
"timezone": "America/New_York",
"account_redirection_url": "https://enterprise.trackvision.ai"
}

Query Parameters

Supports all global query parameters.

Request Body

A partial account object.

Returns

Returns the account object for the created account.


Update an Account

Update an existing account.

PATCH /items/account/:id

{
"account_name": "TrackVision Enterprise - Updated",
"account_description": "Updated enterprise account for comprehensive TV analytics",
"timezone": "America/Los_Angeles"
}

Query Parameters

Supports all global query parameters.

Request Body

A partial account object.

Returns

Returns the account object for the updated account.


Delete an Account

Delete an existing account.

DELETE /items/account/:id

Returns

Empty body.


Sample Data

IDAccount NameTimezoneAccount Redirection URL
9146cd19-ce38-4369-8834-02287ba1ad1bDefault - Renamenullhttps://www.trackvision.ai