Content Management Accounts API

The Accounts API is in phase and is not yet available to users. You can contact the Product-Live team at contact@product-live.com if you want more details and get an early access.

Introduction

An account designates the context of various entities such as tables or users. You have an account in which you have tables, jobs, users... And your partners have an account with which you have shared tables and jobs. With this API, you can get information on your and your partners' account.

The Accounts API Swagger definition is available on our Product-Live API portal here.

General information

• Rate limit: 50 requests per minute

Get Account by id

Request URL

Path parameters

Parameter	Type	Description
accountId	string	An account id Do not confuse with the account key used in Data Factory jobs

Request parameters

None

Request headers

Header	Type	Value
accept	string	application/json
X-Api-Key	string	Your account API key

Request Body

None

Request Example

curl

curl -X 'GET' \
  'GET https://api.product-live.com/v1/accounts/2482' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>'

Response Example

{
    "object": "account",
    "id": "2482",
    "createdAt": "2021-11-22T08:38:07.000Z",
    "updatedAt": "2023-08-23T15:03:18.000Z",
    "key": "4050c573-a0f4-4bcf-b81b-af4fb2f85112",
    "name": "RETAILX"
}

List Accounts

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
page	integer	Optional The page number to retrieve. Default value if missing : 0
size	integer	Optional The number of items per page. Default value if missing : 10

Request headers

Header	Type	Value
accept	string	application/json
X-Api-Key	string	Your account API key

Request Body

None

Request Example

curl

curl -X 'GET' \
  'https://api.product-live.com/v1/accounts?size=1&page=0' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: <REDACTED>'

Response example

{
    "object": "list",
    "data": [
        {
            "object": "account",
            "id": "2482",
            "createdAt": "2021-11-22T08:38:07.000Z",
            "updatedAt": "2023-08-23T15:03:18.000Z",
            "key": "4050c573-a0f4-4bcf-b81b-af4fb2f85112",
            "name": "RETAILX"
        }
    ],
    "totalElements": 1
}

Find Accounts

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
page	integer	Optional The page number to retrieve. Default value if missing : 0
size	integer	Optional The number of items per page. Default value if missing : 10

Request headers

Header	Type	Value
accept	string	application/json
X-Api-Key	string	Your account API key

Request Body

See more details on the find request body in the dedicated page Find request.

Single parameter research

{
    "type": "search",
    "caseSensitive": true,
    "field": "name",
    "value": "RETAIL"
}

Multiple parameters research

{
  "type": "and",
  "queries": [
    {
        "type": "search",
        "caseSensitive": true,
        "field": "name",
        "value": "RETAIL"
    },
    {
        "type": "greaterOrEqual",
        "caseSensitive": true,
        "field": "createdAt",
        "value": "2021-12-30T10:17:29.000Z"
    }
  ]
}

Request Example

curl

curl -X 'POST' \
  'https://api.product-live.com/v1/accounts/find?size=10&page=0' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>'
  -d '{
  "type": "and",
  "queries": [
        {
        "type": "search",
        "caseSensitive": true,
        "field": "name",
        "value": "RETAIL"
    },
    {
        "type": "greaterOrEqual",
        "caseSensitive": true,
        "field": "createdAt",
        "value": "2021-12-30T10:17:29.000Z"
    }
  ]
}'

typescript SDK

Response example

{
    "object": "list",
    "data": [
        {
            "object": "account",
            "id": "2490",
            "createdAt": "2021-12-30T10:17:29.000Z",
            "updatedAt": "2021-12-30T10:17:29.000Z",
            "key": "2e729b23-f04b-447d-ba7b-4ecb72d804f9",
            "name": "RETAILX"
        }
    ],
    "totalElements": 1
}