InsightIQ

https://docs.insightiq.ai/docs/api-reference
Admin
InsightIQ is an API gateway that provides developers access to creator and independent worker data...
Tokens:74,979
Snippets:311
Trust Score:8.2
Update:8 months ago
Show doc for...
Tokens:
Raw
### Open Connect SDK

Source: https://docs.insightiq.ai/docs/api-reference/connect-SDK/getting-started-with-connect-SDK

Opens the Connect SDK interface to allow creators to connect their work platforms. This action is performed on the frontend after the SDK has been initialized.

```javascript
connectSDK.open();
```

--------------------------------

### Initialize Connect SDK

Source: https://docs.insightiq.ai/docs/api-reference/connect-SDK/getting-started-with-connect-SDK

Initializes the Connect SDK on the frontend after obtaining an SDK token. Requires parameters such as client display name, environment mode (sandbox, staging, or production), user ID, and optionally a work platform ID.

```javascript
connectSDK.initialize({
  client_display_name: "Your App Name",
  environment: "sandbox", // or "staging" or "production"
  user_id: "user_id_from_insightiq_api",
  work_platform_id: "optional_work_platform_id"
});
```

--------------------------------

### Create SDK Token

Source: https://docs.insightiq.ai/docs/api-reference/connect-SDK/getting-started-with-connect-SDK

Generates a short-lived SDK token for authenticating with the InsightIQ API. This token is valid for one week and should be used for backend requests.

```APIDOC
## POST /v1/sdk-token

### Description
Generates a short-lived SDK token for authenticating with the InsightIQ API. This token is valid for one week and should be used for backend requests.

### Method
POST

### Endpoint
https://api.sandbox.insightiq.ai/v1/sdk-token

### Parameters
#### Query Parameters
None

#### Request Body
- **user_id** (string) - Required - A unique identifier for the user.
- **products** (array of strings) - Required - A list of products to request access for. Example: ["IDENTITY", "ENGAGEMENT", "INCOME"]

### Request Example
```json
{
  "user_id": "John Doe",
  "products": [
    "IDENTITY",
    "IDENTITY.AUDIENCE",
    "ENGAGEMENT",
    "ENGAGEMENT.AUDIENCE",
    "INCOME"
  ]
}
```

### Response
#### Success Response (200)
- **sdk_token** (string) - The generated SDK token.
- **expires_in** (integer) - The token's validity period in seconds.

#### Response Example
```json
{
  "sdk_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 604800
}
```
```

--------------------------------

### Create SDK Token API Request

Source: https://docs.insightiq.ai/docs/api-reference/connect-SDK/getting-started-with-connect-SDK

Generates a short-lived SDK token required for initializing the Connect SDK. This token is valid for one week and should be stored securely. The request requires an Authorization header and a JSON body containing user ID and desired products.

```shell
POST https://api.sandbox.insightiq.ai/v1/sdk-token
Authorization: <YOUR_API_KEY>
Content-Type: application/json

{
  "user_id": "John Doe",
  "products": [
    "IDENTITY",
    "IDENTITY.AUDIENCE",
    "ENGAGEMENT",
    "ENGAGEMENT.AUDIENCE",
    "INCOME"
  ]
}
```

--------------------------------

### InsightIQ Webhook Bulk Retrieval Request Example

Source: https://docs.insightiq.ai/docs/api-reference/guides/handling-insightiq-webhooks

This example demonstrates the structure of a POST request to the InsightIQ bulk retrieval endpoint. It shows how to send an array of IDs to fetch corresponding data in a single call, improving efficiency over individual GET requests.

```json
{
  "ids": [
    "id1",
    "id2",
    "id3"
  ]
}
```

--------------------------------

### API Response Example

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-publication-contents

This is an example of a successful response from the InsightIQ API. It returns a JSON object containing a 'data' array, where each element represents a publication with its associated metadata, user information, engagement metrics, and content details.

```json
{
  "data": [
    {
      "id": "ab5eadc8-e8c2-46f9-b000-f5a70bc0b5a8",
      "created_at": "2021-11-23T19:37:05.526900",
      "updated_at": "2021-11-23T19:37:05.526900",
      "user": {
        "id": "3b38559b-892f-475d-b4df-7248ef1fd405",
        "name": "Jonah Hill"
      },
      "account": {
        "id": "a3970259-6740-4131-9058-2f5a4c0d17fa",
        "platform_username": "jonah.hill@gmail.com"
      },
      "work_platform": {
        "id": "7645460a-96e0-4192-a3ce-a1fc30641f72",
        "name": "Twitter",
        "logo_url": "https://cdn.insightiq.ai/platforms_logo/logos/logo_twitter.png"
      },
      "engagement": {
        "like_count": 100,
        "dislike_count": null,
        "comment_count": 45,
        "impression_organic_count": 54,
        "reach_organic_count": null,
        "save_count": null,
        "view_count": 200,
        "watch_time_in_hours": null,
        "share_count": 12,
        "impression_paid_count": null,
        "reach_paid_count": null
      },
      "external_id": "5790fbc3-b022-437b-abf8-0492c7a82056",
      "title": "Shout to @tuckerBud for a fab NFT drop",
      "format": "TEXT",
      "type": "TWEET",
      "url": "https://twitter.com/theRealJonah/status/1453423367340580866",
      "media_url": null,
      "duration": null,
      "description": null,
      "visibility": "PUBLIC",
      "thumbnail_url": "https://twitter.com/realJonah/1453423367340580867",
      "published_at": "2021-05-28T00:00:00",
      "platform_profile_id": null,
      "platform_profile_name": null,
      "sponsored": null,
      "collaboration": null
    },
    {
      "id": "65c3f449-ee80-4b31-aa51-6dc7b0f1cb97",
      "created_at": "2021-11-23T19:37:05.526900",
      "updated_at": "2021-11-23T19:37:05.526900",
      "user": {
        "id": "3b38559b-892f-475d-b4df-7248ef1fd405",
        "name": "Jonah Hill"
      },
      "account": {
        "id": "a3970259-6740-4131-9058-2f5a4c0d17fa",
        "platform_username": "jonah.hill@gmail.com"
      },
      "work_platform": {
        "id": "7645460a-96e0-4192-a3ce-a1fc30641f72",
        "name": "Twitter",
        "logo_url": "https://cdn.insightiq.ai/platforms_logo/logos/logo_twitter.png"
      },
      "engagement": {
        "like_count": 100,
        "dislike_count": null,
        "comment_count": 45,
        "impression_organic_count": 54,
        "reach_organic_count": null,
        "save_count": null,
        "view_count": 200,
        "watch_time_in_hours": null,
        "share_count": 12,
        "impression_paid_count": null,
        "reach_paid_count": null
      },
      "external_id": "14ea686e-7c2f-4077-8795-1495c989dc60",
      "title": "Need to do some grown up movie, HMU with scrips",
      "format": "TEXT",
      "type": "TWEET",
      "url": "https://twitter.com/theRealJonah/status/1453423367340580866",
      "media_url": null,
      "description": null,
      "visibility": "PUBLIC",
      "thumbnail_url": "https://twitter.com/realJonah/1453423367340580867",
      "published_at": "2021-05-26T00:00:00",
      "platform_profile_id": null,
      "platform_profile_name": null,
      "sponsored": null,
      "collaboration": null
    },
    {
      "id": "ca094d06-f9c5-4120-b67d-a6438ab2225b",
      "created_at": "2021-11-23T19:37:05.526900",
      "updated_at": "2021-11-23T19:37:05.526900",
      "user": {
        "id": "b0562ead-6282-404f-9e63-9da7bc0f838f",
        "name": "Mark Ruffalo"
      },
      "account": {
        "id": "1639b5c5-facb-4555-8e55-3433cafe0c6b",
        "platform_username": "mark.ruffalo@gmail.com"
      },
      "work_platform": {
        "id": "14d9ddf5-51c6-415e-bde6-f8ed36ad7054",
        "name": "YouTube",
        "logo_url": "https://cdn.insightiq.ai/platforms_logo/logos/logo_youtube.png"
      },
      "engagement": {
        "like_count": 1097,
        "dislike_count": 234,
        "comment_count": 45,
        "impression_organic_count": 54,
        "reach_organic_count": 8767,
        "save_count": 24
      }
    }
  ]
}
```

--------------------------------

### Get Work Platforms - cURL Request

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-work-platforms

This snippet demonstrates how to make a GET request to the InsightIQ AI API to retrieve a list of work platforms. It includes the necessary URL, HTTP method, and headers for authentication and content negotiation. The request uses basic authentication.

```shell
curl --request GET \
  --url https://api.sandbox.insightiq.ai/v1/work-platforms \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic 123'
```

--------------------------------

### Retrieve All Work Platforms (GET)

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-work-platforms

Fetches a list of all supported work platforms. This endpoint does not require any request body and returns a JSON object containing platform details, including their status, logo, and supported products.

```http
GET /v1/work-platforms
```

--------------------------------

### GET /v1/work-platforms

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-work-platforms

Retrieves a list of all supported work platforms. This endpoint allows filtering by date range and pagination.

```APIDOC
## GET /v1/work-platforms

### Description
Retrieves a list of all supported work platforms. This endpoint allows filtering by date range and pagination.

### Method
GET

### Endpoint
/v1/work-platforms

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of work platforms to return. Defaults to 10.
- **offset** (integer) - Optional - The number of work platforms to skip. Defaults to 0.
- **from_date** (string<date>) - Optional - Filter results from this date (YYYY-MM-DD).
- **to_date** (string<date>) - Optional - Filter results up to this date (YYYY-MM-DD).

### Request Example
```shell
curl --request GET \
  --url https://api.sandbox.insightiq.ai/v1/work-platforms \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic 123'
```

### Response
#### Success Response (200)
- **data** (array[WorkPlatform]) - A list of work platform objects.
  - **id** (string<uuid>) - Unique identifier for the work platform.
  - **name** (string) - Name of the work platform.
  - **logo_url** (string<uri>) - Image URL for the work platform logo.
  - **created_at** (string<date-time>) - Object creation timestamp (UTC date and time in ISO 8601 format).
  - **updated_at** (string<date-time>) - Object updation timestamp (UTC date and time in ISO 8601 format).
  - **category** (string) - Category of the work platform. Allowed values: MEDIA, EDUCATION, SOCIAL, ENTERTAINMENT, LIFESTYLE, BUSINESS.
  - **status** (string) - Current status of the work platform. Allowed values: ACTIVE, INACTIVE.
  - **url** (string<uri>) - URL of the work platform.
  - **products** (object) - Details about supported products for the platform.

#### Response Example
```json
{
  "data": [
    {
      "id": "3f996edf-fec1-4be7-bb53-f9b649f41058",
      "name": "Discord",
      "logo_url": "https://cdn.insightiq.ai/platforms_logo/logos/logo_discord.png",
      "created_at": "2022-03-04T10:06:41.871329",
      "updated_at": "2022-03-04T10:06:41.871329",
      "category": "ENTERTAINMENT",
      "status": "ACTIVE",
      "url": "https://discord.com/",
      "products": {
        "identity": {
          "is_supported": true,
          "audience": {
            "is_supported": false
          }
        },
        "engagement": {
          "is_supported": true,
          "audience": {
            "is_supported": false
          }
        },
        "income": {
          "is_supported": false
        },
        "switch": {
          "is_supported": false
        },
        "activity": {
          "is_supported": false
        },
        "publish": {
          "is_supported": false
        }
      }
    }
  ]
}
```
```

--------------------------------

### Income Webhook Event Examples (JSON)

Source: https://docs.insightiq.ai/docs/api-reference/API/webhook-events

Provides JSON examples for various income-related webhook events, including TRANSACTIONS.ADDED, TRANSACTIONS.UPDATED, PAYOUTS.ADDED, PAYOUTS.UPDATED, BALANCES.ADDED, and BALANCES.UPDATED. These events contain data such as account ID, user ID, last updated time, and a list of item IDs.

```json
{
  "event": "TRANSACTIONS.ADDED",
  "name": "transactions added",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}
```

```json
{
  "event": "TRANSACTIONS.UPDATED",
  "name": "transactions updated",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}
```

```json
{
  "event": "PAYOUTS.ADDED",
  "name": "payouts added",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}
```

```json
{
  "event": "PAYOUTS.UPDATED",
  "name": "payouts updated",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}
```

```json
{
  "event": "BALANCES.ADDED",
  "name": "balances added",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}
```

```json
{
  "event": "BALANCES.UPDATED",
  "name": "balances updated",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}
```

--------------------------------

### GET /v1/accounts

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-accounts

Retrieves a list of all accounts. An account represents a user account on the work platform, and a user can connect multiple accounts across different work platforms.

```APIDOC
## GET /v1/accounts

### Description
Lists all Accounts. An Account represents the user account on the work platform end. A user can connect multiple accounts in the same or across multiple work platforms.

### Method
GET

### Endpoint
https://api.sandbox.insightiq.ai/v1/accounts

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The number of objects to be returned. It can be between 1 to 100. The default value is 10.
- **offset** (integer) - Optional - The number of objects to skip. Use this argument for pagination. The default value is 0.
- **user_id** (string) - Optional - Unique ID of the user. Example: 12ccaf87-66c2-4b8e-9bf0-d0e8705334d1
- **work_platform_id** (string) - Optional - Unique ID of the work platform. Example: 12ccaf87-66c2-4b8e-9bf0-d0e8705334d1

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **request-id** (string<uuid>) - Required - Unique ID associated with this request. Please quote this request while requesting support.
- Returns all Account objects.

#### Response Example
```json
{
  "example": "[Account objects will be listed here]"
}
```

### Security
Basic Auth
```

--------------------------------

### GET /v1/accounts

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-accounts

Retrieves a list of all connected work platform accounts for the authenticated user. Supports filtering and pagination.

```APIDOC
## GET /v1/accounts

### Description
Retrieves a list of all connected work platform accounts. This endpoint allows users to view their linked accounts and associated data. It supports query parameters for filtering and pagination.

### Method
GET

### Endpoint
/v1/accounts

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of accounts to return. Defaults to 10.
- **offset** (integer) - Optional - The number of accounts to skip before starting to collect the result set. Defaults to 0.
- **user_id** (string) - Optional - Filters accounts by a specific user ID.
- **work_platform_id** (string) - Optional - Filters accounts by a specific work platform ID.
- **from_date** (string<date>) - Optional - Filters accounts created on or after this date (YYYY-MM-DD).
- **to_date** (string<date>) - Optional - Filters accounts created on or before this date (YYYY-MM-DD).

### Request Example
```shell
curl --request GET \
  --url https://api.sandbox.insightiq.ai/v1/accounts?limit=10&offset=0 \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic YOUR_API_KEY'
```

### Response
#### Success Response (200)
- **data** (array[Account]) - A list of account objects.
  - **id** (string<uuid>) - Unique ID of the connected account.
  - **created_at** (string<date-time>) - Account creation time (UTC date and time in ISO 8601 format).
  - **updated_at** (string<date-time>) - Account updation time (UTC date and time in ISO 8601 format).
  - **user** (UserAttribute) - User details associated with the account.
  - **work_platform** (WorkPlatformAttribute) - Work platform details.
  - **platform_username** (string or null) - Username on the connected platform.
  - **profile_pic_url** (string<uri> or null) - URL of the user's profile image.
  - **status** (string) - Account connection status (CONNECTED, NOT_CONNECTED, SESSION_EXPIRED).
  - **platform_profile_name** (string) - User's profile name on the work platform.
  - **platform_profile_id** (string) - Unique profile ID on the work platform.
  - **platform_profile_published_at** (string<date-time> or null) - Timestamp when the profile was created on the platform.
- **metadata** (Metadata) - Metadata about the response.
  - **offset** (integer) - Offset value used in the query.
  - **limit** (integer) - Limit value used in the query.

#### Response Example
```json
{
  "data": [
    {
      "id": "12ccaf87-66c2-4b8e-9bf0-d0e8705334d1",
      "created_at": "2020-03-27T12:56:34.534978",
      "updated_at": "2020-03-27T12:56:34.534978",
      "user": { ... },
      "work_platform": { ... },
      "platform_username": "john.boyer@gmail.com",
      "profile_pic_url": "https://platform_domain_name/profile_pic_image.png",
      "status": "CONNECTED",
      "platform_profile_name": "CBSE WINNERS",
      "platform_profile_id": "UCEyLTzBtHJhlUwkeWhxfMXw",
      "platform_profile_published_at": "2020-03-27T12:56:34.534978"
    }
  ],
  "metadata": {
    "offset": 0,
    "limit": 10
  }
}
```
```

--------------------------------

### Create a Connection Link (POST)

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-work-platforms

Initiates the creation of a connection link for a user to connect their platform accounts. This POST request requires a JSON body with user ID and callback URLs.

```http
POST /v1/connect-links
```

--------------------------------

### Listen for Account Connected Event

Source: https://docs.insightiq.ai/docs/api-reference/connect-SDK/getting-started-with-connect-SDK

Listens for the `onAccountConnected` event emitted by the Connect SDK upon successful account connection. This event provides `account_id` and `user_id` for further processing. A corresponding webhook event `ACCOUNTS.CONNECTED` is also sent to the backend.

```javascript
connectSDK.on('onAccountConnected', (event) => {
  console.log('Account connected:', event);
  // Transfer event.account_id and event.user_id to your backend
});
```

--------------------------------

### Phyllo Usage API - Create User

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-users

Create a new user in the system.

```APIDOC
## POST /users

### Description
Creates a new user with the provided external identifier.

### Method
POST

### Endpoint
/users

### Parameters
#### Request Body
- **external_id** (string) - Required - The unique external identifier for the new user.

### Request Example
```json
{
  "external_id": "new_external_user_111"
}
```

### Response
#### Success Response (200)
- **user_id** (string) - The unique identifier of the newly created user.
- **external_id** (string) - The external identifier provided for the user.

#### Response Example
```json
{
  "user_id": "user_new789",
  "external_id": "new_external_user_111"
}
```
```

--------------------------------

### Retrieve All Accounts (GET)

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-work-platforms

Retrieves a list of all accounts associated with a given user. This GET request can be filtered by user ID.

```http
GET /v1/accounts
```

--------------------------------

### Retrieve an Account (GET)

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-work-platforms

Fetches details of a specific user account connected through Phyllo. This GET request uses the account ID to identify the target account.

```http
GET /v1/accounts/{accountId}
```

--------------------------------

### Phyllo Usage API - Create Connection Link

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-users

Generate a link to initiate the connection process for a user.

```APIDOC
## POST /connections/link

### Description
Generates a unique link that guides users through the process of connecting their accounts.

### Method
POST

### Endpoint
/connections/link

### Parameters
#### Request Body
- **user_id** (string) - Required - The ID of the user initiating the connection.
- **platform_id** (string) - Required - The ID of the platform to connect to.
- **redirect_uri** (string) - Optional - The URI to redirect to after connection completion.

### Request Example
```json
{
  "user_id": "user_xyz123",
  "platform_id": "platform_123",
  "redirect_uri": "https://myapp.com/callback"
}
```

### Response
#### Success Response (200)
- **link_id** (string) - The unique identifier for the connection link.
- **url** (string) - The generated URL for the connection process.

#### Response Example
```json
{
  "link_id": "link_def456",
  "url": "https://connect.phyllo.co/connect/link_def456"
}
```
```

--------------------------------

### Retrieve a User (GET)

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-work-platforms

Retrieves details for a specific user based on their unique Phyllo user ID. This operation is a GET request and does not require a request body.

```http
GET /v1/users/{userId}
```

--------------------------------

### Retrieve a User by External ID (GET)

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-work-platforms

Fetches a user's details using their external identifier. This GET request requires the external ID to be provided as a query parameter.

```http
GET /v1/users/external/{externalId}
```

--------------------------------

### Create an SDK Token (POST)

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-work-platforms

Generates an SDK token required for client-side integrations. This POST request needs a JSON payload specifying the user ID and desired token scope.

```http
POST /v1/sdk-tokens
```

--------------------------------

### Phyllo Usage API - Create SDK Token

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-users

Generate an SDK token for authenticated access.

```APIDOC
## POST /sdk/token

### Description
Creates a secure token for SDK authentication and authorization.

### Method
POST

### Endpoint
/sdk/token

### Parameters
#### Request Body
- **user_id** (string) - Required - The ID of the user for whom the token is generated.
- **ttl** (integer) - Optional - Time-to-live for the token in seconds.

### Request Example
```json
{
  "user_id": "user_xyz123",
  "ttl": 3600
}
```

### Response
#### Success Response (200)
- **token** (string) - The generated SDK token.
- **expires_at** (string) - The expiration timestamp of the token.

#### Response Example
```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_at": "2023-10-27T11:00:00Z"
}
```
```

--------------------------------

### Phyllo Usage API - Retrieve All Work Platforms

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-users

Retrieve a list of all available work platforms.

```APIDOC
## GET /platforms

### Description
Retrieves a list of all available work platforms supported by the API.

### Method
GET

### Endpoint
/platforms

### Response
#### Success Response (200)
- **platforms** (array) - A list of work platform objects.
  - **platform_id** (string) - The unique identifier of the work platform.
  - **name** (string) - The name of the work platform.

#### Response Example
```json
{
  "platforms": [
    {
      "platform_id": "platform_123",
      "name": "Example Platform 1"
    },
    {
      "platform_id": "platform_456",
      "name": "Example Platform 2"
    }
  ]
}
```
```

--------------------------------

### InsightIQ Webhook Bulk Retrieval Response Example

Source: https://docs.insightiq.ai/docs/api-reference/guides/handling-insightiq-webhooks

This example illustrates the expected JSON response structure from the InsightIQ bulk retrieval API. It contains a 'data' array, where each element is an object corresponding to the IDs provided in the request.

```json
{
  "data": [
    {
      "id": "id1",
      "attribute": "value"
    },
    {
      "id": "id2",
      "attribute": "value"
    }
  ]
}
```

--------------------------------

### Social Transaction Response Example (JSON)

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/create-a-v-1-social-income-transaction-search

This is an example of the JSON response received when successfully retrieving social transactions. It contains an array of 'SocialTransaction' objects, each with details like ID, timestamps, user information, amount, currency, and platform-specific data.

```json
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created_at": "2020-03-27T12:56:34.534978",
      "updated_at": "2020-03-27T12:56:34.534978",
      "user": {
        "id": "fb83e3ca-eae7-4eaa-bf51-601ea4b3daeb",
        "name": "John Doe"
      },
      "account": {
        "id": "fb83e3ca-eae7-4eaa-bf51-601ea4b3daeb",
        "platform_username": "john.doe@gmail.com"
      },
      "work_platform": {
        "id": "fb83e3ca-eae7-4eaa-bf51-601ea4b3daeb",
        "name": "Instagram",
        "logo_url": "https://insightiq.ai/storage/instagram.png"
      },
      "amount": 123.45,
      "type": "AD",
      "cpm": 6.78,
      "currency": "USD",
      "external_id": "5790fbc3-b022-437b-abf8-0492c7a82056",
      "transaction_at": "2020-03-27T12:56:34.534978",
      "platform_profile_id": "UCEyLTzBtHJhlUwkeWhxfMXw",
      "platform_profile_name": "Peter Parker"
    }
  ]
}
```

--------------------------------

### Create a User (POST)

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-work-platforms

Creates a new user within the Phyllo system. This POST request requires a JSON body containing user information, such as external ID and platform details.

```http
POST /v1/users
```

--------------------------------

### GET /v1/social/income/payouts/{payout_id}

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-social-income-payouts

Retrieves details for a specific social payout using its unique identifier.

```APIDOC
## GET /v1/social/income/payouts/{payout_id}

### Description
Retrieves the details of a specific social payout identified by its unique payout ID.

### Method
GET

### Endpoint
/v1/social/income/payouts/{payout_id}

### Parameters
#### Path Parameters
- **payout_id** (string) - Required - The unique identifier of the payout to retrieve.

### Request Example
```bash
curl --request GET \
  --url https://api.sandbox.insightiq.ai/v1/social/income/payouts/5790fbc3-b022-437b-abf8-0492c7a82056 \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic <your_credentials>'
```

### Response
#### Success Response (200)
- **id** (string<uuid>) - Required - Unique ID of the payout.
- **created_at** (string<date-time>) - Required - Object creation time (UTC date and time in ISO 8601 format).
- **updated_at** (string<date-time>) - Required - Object updation time (UTC date and time in ISO 8601 format).
- **user** (UserAttribute) - Required - User details.
- **account** (AccountAttribute) - Required - Account details.
- **work_platform** (WorkPlatformAttribute) - Required - Work platform details.
- **amount** (number) - Required - Amount for the given payout.
- **currency** (string) - Required - 3 letter currency code as per ISO 4217.
- **status** (string) - Required - Status of the payout on the source platform (SCHEDULED, PAID, IN_TRANSIT, CANCELLED).
- **payout_interval** (string) - Required - Regular interval at which the source platform processes payouts (AUTOMATIC_DAILY, AUTOMATIC_WEEKLY, AUTOMATIC_MONTHLY, MANUAL).
- **bank_details** (object) - Bank details to which the payouts are sent.
  - **external_id** (string or null) - Required - Payout ID given by the source platform.
  - **payout_at** (string<date-time>) - Required - Date or timestamp of payout.
  - **platform_profile_id** (string) - Required - Unique profile ID of the user on the work platform.
  - **platform_profile_name** (string or null) - Required - User's profile name on the work platform.

#### Response Example
```json
{
  "id": "5790fbc3-b022-437b-abf8-0492c7a82056",
  "created_at": "2020-03-27T12:56:34.534978",
  "updated_at": "2020-03-27T12:56:34.534978",
  "user": {
    "id": "fb83e3ca-eae7-4eaa-bf51-601ea4b3daeb",
    "name": "John Doe"
  },
  "account": {
    "id": "fb83e3ca-eae7-4eaa-bf51-601ea4b3daeb",
    "platform_username": "john.doe@gmail.com"
  },
  "work_platform": {
    "id": "fb83e3ca-eae7-4eaa-bf51-601ea4b3daeb",
    "name": "Instagram",
    "logo_url": "https://insightiq.ai/storage/instagram.png"
  },
  "amount": 123.45,
  "currency": "USD",
  "status": "SCHEDULED",
  "payout_interval": "AUTOMATIC_DAILY",
  "bank_details": {
    "name": "string",
    "account_last_digits": "string",
    "account_routing_number": "string"
  },
  "external_id": "5790fbc3-b022-437b-abf8-0492c7a82056",
  "payout_at": "2020-03-27T12:56:34.534978",
  "platform_profile_id": "UCEyLTzBtHJhlUwkeWhxfMXw",
  "platform_profile_name": "Peter Parker"
}
```
```

--------------------------------

### Retrieve All Accounts (cURL)

Source: https://docs.insightiq.ai/docs/api-reference/api/ref/operations/list-v-1-accounts

This snippet demonstrates how to retrieve all connected accounts using a cURL command. It requires an API key for authentication and specifies the desired response format as JSON.

```shell
curl --request GET \
  --url https://api.sandbox.insightiq.ai/v1/accounts \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic 123'
```
Tokens:
Raw