Retrieve social transactions for an account

Lists all transactions of the given social account.

Check the category field from the work platform API response or the "Category" column in this data guide to see which platfroms we serve under "social".

GET /v1/social/income/transactions

Basic auth

curl 'https://api.sandbox.insightiq.ai/v1/social/income/transactions?transaction_from_date=2021-01-31&transaction_to_date=2021-01-31&account_id=123e4567-e89b-42d3-a456-426614174000&type=AD&limit=10&offset=0' \
  --request GET \
  --header 'Authorization: Basic YOUR_BASE64_CREDENTIALS'

{
  "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": "[email protected]"
      },
      "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"
    }
  ],
  "metadata": [
    {
      "offset": 0,
      "limit": 10,
      "from_date": "2020-12-31",
      "to_date": "2021-12-31"
    }
  ]
}

Returns all transaction objects for the given account.

Query parameters

· 6

transaction_from_date string · date required

Return transactions on or after this date. (YYYY-MM-DD)

transaction_to_date string · date required

Return transactions on or before this date. (YYYY-MM-DD)

account_id string · uuid required

Unique ID of the connected account.

type string · enum

Type of transaction on the social platform

values

AD
SUBSCRIPTION
ADDITIONAL

limit integer · min: 1· max: 100· default: 10

The number of objects to be returned. It can be between 1 to 100. The default value is 10.

offset integer · min: 0· default: 0

The number of objects to skip. Use this argument for pagination. The default value is 0.

Query parameters

Responses