Endpoints

Ads Campaign Structure

Each client should attach the Facebook account to the WABA before the partner can work with data from META. See Meta's Official Documentation about Ads Campaign Structure.

Configuring Tracking Keywords

Activate CTWA-tracking for stack (number) before configure conversions. See How to manage the tracking of Signals API.

To effectively use this API, it is essential to configure the appropriate keywords that will be tracked.

See Trackable Events (Keywords).

Best Practices

Here are some Best Practices that you can follow to configure keywords for the Signals API:

Define your campaign objectives: Before you begin configuring keywords, it is essential to have a clear understanding of your campaign objectives. This will help you determine the types of keywords that you should track.
Identify relevant keywords: Once you have defined your campaign objectives, you can start identifying relevant keywords. These are the words and phrases that users are likely to search for when looking for products or services related to your campaign. Try to configure "unique" keywords to track - it will help avoid false-positive results
Configure the Signals API: After identifying keywords, you can configure the Signals API to track the performance of each group of keywords.
Monitor performance: Once you have configured the Signals API to track your keywords, it is important to monitor performance regularly. This will help you identify areas where you need to make changes to optimize your campaigns.

Analyzing Results

The Signals API provides the capability to read data at various levels, offering flexibility and granularity in the data you can access. Depending on your use case, you can choose to read data at the campaign, ad group, ad, or keyword level.

Ad Overview: This provides an overview of your ad campaign's performance, including metrics such as impressions, clicks, and spend. This information is updated on a daily basis, allowing you to stay up-to-date with your campaign's progress.
Ad Daily Insights: Detailed day-by-day information is available to help you compare campaign results over time. This allows you to identify trends and patterns in your campaign's performance and make informed decisions about how to optimize your advertising efforts. This information is updated on a daily basis.
Conversion Insights: The API provides summary statistics per conversion, allowing you to track how well your keywords are performing. This information is updated on a daily basis, giving you insights into your campaign's conversion rates.
Events List: For granular information about each conversion event, the API provides an events list that is updated instantly. This feature allows you to track individual events and analyze their impact on your campaign's overall performance.

Signals Endpoints

Base-URL

Retrieve Client's Facebook Accounts IDs

To retrieve the client_id of clients - check Get List of Clients.

Important! Make sure you use HUB Base URL prefix for Get List of Clients.

Signals API don't support /partners endpoint.

Retrieve list of attached Facebook accounts of the client

GET https://api.signals.360dialog.io/v1/clients/{client_id}/facebook-accounts

Send a GET request and pick one Facebook account. In case of empty list - ask client to attach Facebook account first.

[
  {
    "id": "2311334042249923",
    "email": "advertiser@gmail.com"
  }
]

GET https://api.signals.360dialog.io/v1/clients/{client_id}/facebook-accounts/{facebook_account}

Send a GET request and pick the Ad account.

[
  {
    "id": "1011872785512566",
    "name": "Advertiser Company Name"
  }
]

GET https://api.signals.360dialog.io/v1/app/{app_id}/ads/account/{ad_account_id}

Send a GET request and read list of Ads.

To work with pagination concept: offset and limit params are available.

Query Parameters

{
  "data": [
    {
      "id": "23852030589290425",
      "app_id": "93310",
      "name": "CTWA Ad Campaign",
      "status": "ACTIVE",
      "created_time": "2022-11-30T14:05:08+0100",
      "updated_time": "2022-11-30T14:05:08+0100",
      "ad_account": {
        "id": "174816537731874",
        "name": "360dialog.com - Ad-Account",
        "currency": "EUR"
      },
      "campaign": {
        "name": "CTWA campaign",
        "start_time": "2022-11-30T14:05:08+0100"
      },
      "page": {
        "id": "460293477343848",
        "name": "360dialog"
      },
      "insight": {
        "ad_id": "23851172049950328",
        "date": "2023-02-28T08:01:15.667Z",
        "clicks": 541,
        "cpc": 0.8,
        "cpm": 28.04,
        "ctr": 3.5,
        "impressions": 15452,
        "spend": 433.3,
        "sessions": 498,
        "unique_users": 495,
        "keywords_count": 3
      }
    }
  ],
  "total_count": 1,
  "offset": 0,
  "limit": 20
}

schema

For assistance with Signals endpoints, please contact our Support Team.

Meta Ads

Get Ads

GET [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/ads/account/{ad_account_id}

Return paginated ad list for given app_id and fb ad_account_id

Request Example curl --request GET --url [base-url] /v1/clients/client_id/apps/app_id/ads/account/ad_account_id --header 'Accept: application/json' --header 'Authorization: Bearer'

Path Parameters

Query Parameters

{
  "data": [
    {
      "id": "23851172049950328",
      "ad_account_id": "174816537731874",
      "ad_account": {
        "name": "360dialog.com - Ad-Account",
        "currency": "EUR"
      },
      "ad_set": {
        "name": "Spot ad set",
        "status": "ACTIVE"
      },
      "name": "Spot image",
      "status": "ACTIVE",
      "created_time": "2022-11-01T10:05:08+01:00",
      "updated_time": "2022-11-30T14:05:08+01:00",
      "campaign": {
        "id": "23851172049950328",
        "ad_account_id": "174816537731874",
        "ad_account": {
          "name": "360dialog.com - Ad-Account",
          "currency": "EUR"
        },
        "name": "Spot image",
        "status": "ACTIVE",
        "start_time": "2022-11-01T10:05:08+01:00",
        "stop_time": "2022-11-30T14:05:08+01:00",
        "page": {
          "id": "460293477343848"
        },
        "insight": {
          "campaign_id": "23851172049950328",
          "date": "2023-02-28T08:01:15.667000",
          "clicks": 1234,
          "cpc": 0.3,
          "cpm": 3.4,
          "ctr": 1.4,
          "impressions": 6789,
          "spend": 123.45,
          "currency": "EUR",
          "sessions": 6789,
          "cost_per_session": 0.45,
          "cvr_clicks_to_sessions": 0.45,
          "unique_users": 5999,
          "cost_per_unique_user": 0.45,
          "cvr_clicks_to_unique_users": 0.45,
          "engaged": 5999,
          "cost_per_engagement": 0.45,
          "cvr_unique_users_to_engaged": 0.45,
          "converted": 5999,
          "cost_per_conversions": 0.45,
          "cvr_unique_users_to_converted": 0.45,
          "events": {
            "conversation": 2,
            "keyword": 0
          },
          "keywords": [
            {
              "keyword": "Product ordered",
              "events": 7,
              "cvr": 1.23
            }
          ]
        },
        "sale_insight": {
          "ad_id": "23851172049950328",
          "date": "2022-10-23T18:54:35",
          "revenue": 500,
          "count": 1,
          "roas": 3,
          "cvr": 2.04,
          "cvr_cost": 1
        }
      },
      "page": {
        "id": "460293477343848"
      },
      "insight": {
        "ad_id": "23851172049950328",
        "date": "2023-02-28T08:01:15.667000",
        "clicks": 1234,
        "cpc": 0.3,
        "cpm": 3.4,
        "ctr": 1.4,
        "impressions": 6789,
        "spend": 123.45,
        "currency": "EUR",
        "sessions": 6789,
        "cost_per_session": 0.45,
        "cvr_clicks_to_sessions": 0.45,
        "unique_users": 5999,
        "cost_per_unique_user": 0.45,
        "cvr_clicks_to_unique_users": 0.45,
        "engaged": 5999,
        "cost_per_engagement": 0.45,
        "cvr_unique_users_to_engaged": 0.45,
        "converted": 5999,
        "cost_per_conversions": 0.45,
        "cvr_unique_users_to_converted": 0.45,
        "events": {
          "conversation": 2,
          "keyword": 0
        },
        "keywords": [
          {
            "keyword": "Product ordered",
            "events": 7,
            "cvr": 1.23
          }
        ]
      },
      "sale_insight": {
        "ad_id": "23851172049950328",
        "date": "2022-10-23T18:54:35",
        "revenue": 500,
        "count": 1,
        "roas": 3,
        "cvr": 2.04,
        "cvr_cost": 1
      },
      "active_event_groups_count": 0
    }
  ],
  "total_count": 0,
  "offset": 0,
  "limit": 0
}

Get Ad

GET [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/ads/{ad_id}

Return ad by id and app_id

Request Example curl --request GET --url [base-url]/v1/clients/client_id/apps/app_id/ads/ad_id --header 'Accept: application/json' --header 'Authorization: Bearer'

Path Parameters

{
  "id": "23851172049950328",
  "ad_account_id": "174816537731874",
  "ad_account": {},
  "ad_set": {},
  "name": "Spot image",
  "status": "ACTIVE",
  "created_time": "2022-11-01T10:05:08+01:00",
  "updated_time": "2022-11-30T14:05:08+01:00",
  "campaign": {
    "id": "23851172049950328",
    "ad_account_id": "174816537731874",
    "ad_account": {
      "name": "360dialog.com - Ad-Account",
      "currency": "EUR"
    },
    "name": "Spot image",
    "status": "ACTIVE",
    "start_time": "2022-11-01T10:05:08+01:00",
    "stop_time": "2022-11-30T14:05:08+01:00",
    "page": {
      "id": "460293477343848"
    },
    "insight": {
      "campaign_id": "23851172049950328",
      "date": "2023-02-28T08:01:15.667000",
      "clicks": 1234,
      "cpc": 0.3,
      "cpm": 3.4,
      "ctr": 1.4,
      "impressions": 6789,
      "spend": 123.45,
      "currency": "EUR",
      "sessions": 6789,
      "cost_per_session": 0.45,
      "cvr_clicks_to_sessions": 0.45,
      "unique_users": 5999,
      "cost_per_unique_user": 0.45,
      "cvr_clicks_to_unique_users": 0.45,
      "engaged": 5999,
      "cost_per_engagement": 0.45,
      "cvr_unique_users_to_engaged": 0.45,
      "converted": 5999,
      "cost_per_conversions": 0.45,
      "cvr_unique_users_to_converted": 0.45,
      "events": {
        "conversation": 2,
        "keyword": 0
      },
      "keywords": [
        {
          "keyword": "Product ordered",
          "events": 7,
          "cvr": 1.23
        }
      ]
    },
    "sale_insight": {
      "ad_id": "23851172049950328",
      "date": "2022-10-23T18:54:35",
      "revenue": 500,
      "count": 1,
      "roas": 3,
      "cvr": 2.04,
      "cvr_cost": 1
    }
  },
  "page": {},
  "insight": {
    "ad_id": "23851172049950328",
    "date": "2023-02-28T08:01:15.667000",
    "clicks": 1234,
    "cpc": 0.3,
    "cpm": 3.4,
    "ctr": 1.4,
    "impressions": 6789,
    "spend": 123.45,
    "currency": "EUR",
    "sessions": 6789,
    "cost_per_session": 0.45,
    "cvr_clicks_to_sessions": 0.45,
    "unique_users": 5999,
    "cost_per_unique_user": 0.45,
    "cvr_clicks_to_unique_users": 0.45,
    "engaged": 5999,
    "cost_per_engagement": 0.45,
    "cvr_unique_users_to_engaged": 0.45,
    "converted": 5999,
    "cost_per_conversions": 0.45,
    "cvr_unique_users_to_converted": 0.45,
    "events": {
      "conversation": 2,
      "keyword": 0
    },
    "keywords": [
      {
        "keyword": "Product ordered",
        "events": 7,
        "cvr": 1.23
      }
    ]
  },
  "sale_insight": {
    "ad_id": "23851172049950328",
    "date": "2022-10-23T18:54:35",
    "revenue": 500,
    "count": 1,
    "roas": 3,
    "cvr": 2.04,
    "cvr_cost": 1
  }
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Ads Insights

GET [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/ads/{ad_id}/insights

Return Multiple Ad Insights from Meta for given app_id, ad_id and date intervals

Request Example curl --request GET --url [base-url]/v1/clients/client_id/apps/app_id/ads/ad_id/insights --header 'Accept: application/json' --header 'Authorization: Bearer'

Path Parameters

[
  {
    "ad_id": "23851172049950328",
    "date": "2023-02-28T08:01:15.667000",
    "clicks": 1234,
    "cpc": 0.3,
    "cpm": 3.4,
    "ctr": 1.4,
    "impressions": 6789,
    "spend": 123.45,
    "currency": "EUR",
    "sessions": 6789,
    "cost_per_session": 0.45,
    "cvr_clicks_to_sessions": 0.45,
    "unique_users": 5999,
    "cost_per_unique_user": 0.45,
    "cvr_clicks_to_unique_users": 0.45,
    "engaged": 5999,
    "cost_per_engagement": 0.45,
    "cvr_unique_users_to_engaged": 0.45,
    "converted": 5999,
    "cost_per_conversions": 0.45,
    "cvr_unique_users_to_converted": 0.45,
    "events": {
      "conversation": 2,
      "keyword": 0
    },
    "keywords": [
      {
        "keyword": "Product ordered",
        "events": 7,
        "cvr": 1.23
      }
    ]
  }
]

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Refresh Ads Insights

POST [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/ads/account/{ad_account_id}/refresh

Refresh Ad Insights for given ad account

Request Example curl --request POST --url [base-url]/v1/clients/{client_id}/apps/{app_id}/ads/account/{ad_account_id}/refresh --header 'Accept: application/json' --header 'Authorization: Bearer'

Path Parameters

{
  "success": true
}

Refresh Ad Insights

POST [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/ads/{ad_id}/refresh

Refresh Ad insights for given ad

Request Example curl --request POST --url [base-url]/v1/clients/client_id/apps/app_id/ads/ad_id/refresh --header 'Accept: application/json' --header 'Authorization: Bearer'

Path Parameters

{
  "success": true
}

Meta Campaigns

Get Campaigns

GET [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/campaigns/account/{ad_account_id}

Return paginated Campaign list for given app_id and ad_account_id

Request Example curl --request POST --url [base-url]/v1/clients/client_id/apps/app_id/campaigns/account/ad_account_id --header 'Accept: application/json' --header 'Authorization: Bearer'

Path Parameters

{
  "data": [
    {
      "id": "23851172049950328",
      "ad_account_id": "174816537731874",
      "ad_account": {
        "name": "360dialog.com - Ad-Account",
        "currency": "EUR"
      },
      "name": "Spot image",
      "status": "ACTIVE",
      "start_time": "2022-11-01T10:05:08+01:00",
      "stop_time": "2022-11-30T14:05:08+01:00",
      "page": {
        "id": "460293477343848"
      },
      "insight": {
        "campaign_id": "23851172049950328",
        "date": "2023-02-28T08:01:15.667000",
        "clicks": 1234,
        "cpc": 0.3,
        "cpm": 3.4,
        "ctr": 1.4,
        "impressions": 6789,
        "spend": 123.45,
        "currency": "EUR",
        "sessions": 6789,
        "cost_per_session": 0.45,
        "cvr_clicks_to_sessions": 0.45,
        "unique_users": 5999,
        "cost_per_unique_user": 0.45,
        "cvr_clicks_to_unique_users": 0.45,
        "engaged": 5999,
        "cost_per_engagement": 0.45,
        "cvr_unique_users_to_engaged": 0.45,
        "converted": 5999,
        "cost_per_conversions": 0.45,
        "cvr_unique_users_to_converted": 0.45,
        "events": {
          "conversation": 2,
          "keyword": 0
        },
        "keywords": [
          {
            "keyword": "Product ordered",
            "events": 7,
            "cvr": 1.23
          }
        ]
      },
      "sale_insight": {
        "ad_id": "23851172049950328",
        "date": "2022-10-23T18:54:35",
        "revenue": 500,
        "count": 1,
        "roas": 3,
        "cvr": 2.04,
        "cvr_cost": 1
      }
    }
  ],
  "total_count": 0,
  "offset": 0,
  "limit": 0
}

Get Campaign

GET [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/campaigns/{campaign_id}

Return campaign by id and app_id

Request Example

curl --request GET --url [base-url]/v1/clients/client_id/apps/app_id/campaigns/campaign_id --header 'Accept: application/json' --header 'Authorization: Bearer'

Path Parameters

{
  "id": "23851172049950328",
  "ad_account_id": "174816537731874",
  "ad_account": {},
  "name": "Spot image",
  "status": "ACTIVE",
  "start_time": "2022-11-01T10:05:08+01:00",
  "stop_time": "2022-11-30T14:05:08+01:00",
  "page": {},
  "insight": {
    "campaign_id": "23851172049950328",
    "date": "2023-02-28T08:01:15.667000",
    "clicks": 1234,
    "cpc": 0.3,
    "cpm": 3.4,
    "ctr": 1.4,
    "impressions": 6789,
    "spend": 123.45,
    "currency": "EUR",
    "sessions": 6789,
    "cost_per_session": 0.45,
    "cvr_clicks_to_sessions": 0.45,
    "unique_users": 5999,
    "cost_per_unique_user": 0.45,
    "cvr_clicks_to_unique_users": 0.45,
    "engaged": 5999,
    "cost_per_engagement": 0.45,
    "cvr_unique_users_to_engaged": 0.45,
    "converted": 5999,
    "cost_per_conversions": 0.45,
    "cvr_unique_users_to_converted": 0.45,
    "events": {
      "conversation": 2,
      "keyword": 0
    },
    "keywords": [
      {
        "keyword": "Product ordered",
        "events": 7,
        "cvr": 1.23
      }
    ]
  },
  "sale_insight": {
    "ad_id": "23851172049950328",
    "date": "2022-10-23T18:54:35",
    "revenue": 500,
    "count": 1,
    "roas": 3,
    "cvr": 2.04,
    "cvr_cost": 1
  }
}

Get Campaign Insights

GET [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/campaigns/{campaign_id}/insights

Return campaign insights for given app_id, ad_id and date intervals

Request Example curl --request GET --url [base-url]/v1/clients/client_id/apps/app_id/campaigns/campaign_id/insights --header 'Accept: application/json' --header 'Authorization: Bearer'

Path Parameters

{
  "data": [
    {
      "id": "23851172049950328",
      "ad_account_id": "174816537731874",
      "ad_account": {
        "name": "360dialog.com - Ad-Account",
        "currency": "EUR"
      },
      "name": "Spot image",
      "status": "ACTIVE",
      "start_time": "2022-11-01T10:05:08+01:00",
      "stop_time": "2022-11-30T14:05:08+01:00",
      "page": {
        "id": "460293477343848"
      },
      "insight": {
        "campaign_id": "23851172049950328",
        "date": "2023-02-28T08:01:15.667000",
        "clicks": 1234,
        "cpc": 0.3,
        "cpm": 3.4,
        "ctr": 1.4,
        "impressions": 6789,
        "spend": 123.45,
        "currency": "EUR",
        "sessions": 6789,
        "cost_per_session": 0.45,
        "cvr_clicks_to_sessions": 0.45,
        "unique_users": 5999,
        "cost_per_unique_user": 0.45,
        "cvr_clicks_to_unique_users": 0.45,
        "engaged": 5999,
        "cost_per_engagement": 0.45,
        "cvr_unique_users_to_engaged": 0.45,
        "converted": 5999,
        "cost_per_conversions": 0.45,
        "cvr_unique_users_to_converted": 0.45,
        "events": {
          "conversation": 2,
          "keyword": 0
        },
        "keywords": [
          {
            "keyword": "Product ordered",
            "events": 7,
            "cvr": 1.23
          }
        ]
      },
      "sale_insight": {
        "ad_id": "23851172049950328",
        "date": "2022-10-23T18:54:35",
        "revenue": 500,
        "count": 1,
        "roas": 3,
        "cvr": 2.04,
        "cvr_cost": 1
      }
    }
  ],
  "total_count": 0,
  "offset": 0,
  "limit": 0
}

Refresh Campaigns Insights

POST [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/campaigns/account/{ad_account_id}/refresh

Refresh campaign insights for given Ad Account

Request Example

curl --request POST --url [base-url]/v1/clients/client_id/apps/app_id/campaigns/account/ad_account_id/refresh --header 'Accept: application/json' --header 'Authorization: Bearer'

Path Parameters

{
  "success": true
}

Refresh Campaign Insights

POST [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/campaigns/{campaign_id}/refresh

Refresh campaign insights for given Campaign

Request Example

curl --request POST --url [base-url]/v1/clients/{client_id}/apps/{app_id}/campaigns/{campaign_id}/refresh --header 'Accept: application/json' --header 'Authorization: Bearer'

Path Parameters

{
  "success": true
}

Events

Events are single instances within your conversion funnel.

Once enabled, Signals automatically tracks default events: button, button_reply, list_reply, conversation, engagement, so there is no need for pre-configuration.

You also have the flexibility to create text-based conversions at any time by using the Event type "conversation" and specifying the Keyword. To set up the Conversion event, you can use the endpoint described below.

Currently, the tracking of a "Conversation" Event is limited to incoming messages from outbound sources. We are actively working to enable tracking for messages sent by the business in the near future.

Create converted event

POST [signals-base-url]/v1/clients/client_id/apps/app_id/converted_events

Request Example

curl --request POST --url [base-url]/v1/clients/client_id/apps/app_id/converted_events --header 'Accept: application/json' --header 'Authorization: Bearer' --header 'Content-Type: application/json' --data '{ "campaign_id": "23851172049950328", "type": "button", "type_id": "63c14b9487dd821c0be8a0b6", "type_value": "product ordered"

Path Parameters

Request Body

{
  "success": true
}

Get Events Types

GET [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/event_types

Request Example

curl --request GET --url [base-url]/v1/clients/client_id/apps/app_id/event_types --header 'Accept: application/json' --header 'Authorization: Bearer 122'

Path Parameters

Query Parameters

[
  {
    "name": "string",
    "value": "button" 
  }
]

//Possible values:
//button
//button_reply
//conversation
//converted
//engagement
//keyword
//link
//list
//list_reply

Get Events

GET [signals-base-url]v1/clients/{client_id}/apps/{app_id}/events

Request Example

curl --request GET --url [base-url]/v1/clients/client_id/apps/app_id/events --header 'Accept: application/json' --header 'Authorization: Bearer'

Path Parameters

Query Parameters

{
  "data": [
    {
      "id": "ABGGeRKYlEBvAgo-sNqg6B4gkcj8",
      "app_id": "72822",
      "ad_id": "23851172049950328",
      "campaign_id": "23851172049950328",
      "phone": "123456789",
      "type": "conversation", //event type
      "type_id": "63c14b9487dd821c0be8a0b6",
      "type_value": "product ordered", //converted event
      "date": "2022-10-23T18:54:35",
      "conversation_id": "12453ewa",
      "conversation_expire_time": "2022-12-01T00:05:08+01:00",
      "source_id": "So2315r13"
    }
  ],
  "total_count": 0,
  "offset": 0,
  "limit": 0
}

Export Events

GET [signals-base-url]v1/clients/{client_id}/apps/{app_id}/events/export

Export events in a CSV file

Request Example

curl --request GET --url [base-url]/v1/clients/client_id/apps/app_id/events/export --header 'Accept: application/json' --header 'Authorization: Bearer 122'

Path Parameters

Query Parameters

Get Event Stats

GET [signals-base-url]v1/clients/{client_id}/apps/{app_id}/standalone-events-stats

Return stats from standalone Events

Request Example

curl --request GET --url [base-url]/v1/clients/client_id/apps/app_id/standalone-events-stats --header 'Accept: application/json' --header 'Authorization: Bearer 122'

Path Parameters

{
  "sessions_num": 0,
  "events_num": 0
}

If you want to get the conversion event for all numbers associated with the business account, you can use the group endpoint. It allows for bulk configuration.

Get Events Groups

GET [signals-base-url]v1/clients/{client_id}/apps/{app_id}/event_groups

Request Example

curl --request GET --url [base-url]/v1/clients/client_id/apps/app_id/event_groups --header 'Accept: application/json' --header 'Authorization: Bearer'

Path Parameters

Query Parameters

{
  "data": [
    {
      "app_id": "72822",
      "ad_id": "23851172049950328",
      "campaign_id": "23851172049950328",
      "type": "conversation",
      "type_id": "63c14b9487dd821c0be8a0b6",
      "type_value": "product ordered",
      "status": "active",
      "first_event": "2022-11-20T14:05:08+01:00",
      "last_event": "2022-11-30T14:05:08+01:00",
      "last_update": "2022-12-01T00:05:08+01:00",
      "events": 10,
      "cvr": 2.04
    }
  ],
  "total_count": 0,
  "offset": 0,
  "limit": 0
}

Creating an Ad Campaign

Facebook Account

Get Facebook Accounts

GET [signals-base-url]v1/clients/{client_id}/apps/{app_id}/facebook-accounts

Request Example

curl --request POST --url [base-url]/v1/clients/client_id/apps/app_id/facebook-accounts --header 'Accept: application/json' --header 'Authorization: Bearer 122' --header 'Content-Type: application/json' --data '{ "temporary_token": "63c14b9487dd821c0be8a0b6" }'

Path Parameters

[
  {
    "id": "100090613944471",
    "name": "Mike Bush",
    "client_id": "bbxYayFhCL",
    "permanent_token": "63c14b9487dd821c0be8a0b6",
    "ad_accounts": [
      {
        "id": "174816537731874",
        "name": "360dialog.com - Ad-Account - 2",
        "currency": "EUR"
      }
    ]
  }
]

Create Facebook Account

POST [signals-base-url]/v1/clients/client_id/apps/app_id/facebook-accounts

Request Example

Path Parameters

Request Body

{
  "success": true
}

Get Facebook Ad Accounts

GET [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/facebook-accounts/{facebook_account_id}

Request Example

curl --request GET --url [base-url]/v1/clients/client_id/apps/app_id/facebook-accounts/facebook_account_id --header 'Accept: application/json' --header 'Authorization: Bearer 122'

Path Parameters

[]

Ad Campaign

Create Facebook Ad Campaign

POST [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/facebook-accounts

Request Example

curl --request POST --url [base-url]/v1/clients/client_id/apps/app_id/facebook-accounts/facebook_account_id/facebook-ad-accounts/facebook_ad_account_id/facebook-ad-campaign --header 'Accept: application/json' --header 'Authorization: Bearer' --header 'Content-Type: application/json' --data '{ "campaign_name": "TEST CTWA POC", "daily_budget": 100, "start_time": "2023-09-18T11:36:41.356737", "end_time": "2023-09-19T12:36:41.356747", "billing_event": "IMPRESSIONS", "body": "Grow your business 5x", "title": "Chat with us", "page_id": "460293477343848", "targeting": { "age_min": 18, "age_max": 65, "gender": "men", "geo_locations": { "countries": [ "US" ], "cities": [ { "key": "1910415" } ] } }, "image_hash": "a275aa36c7b2e6d0105bf683c55e7bd6" }'

Path Parameters

Request Body

{
  "campaign_id": "23853062207880328",
  "adset_id": "43853062207880328",
  "ad_id": "53853062207880328"
}

Get Facebook Pages ID

GET [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/facebook-accounts/{facebook_account_id}/facebook-ad-accounts/{facebook_ad_account_id}/facebook-pages

Request Example

curl --request GET --url [base-url]/v1/clients/client_id/apps/app_id/facebook-accounts/facebook_account_id/facebook-ad-accounts/facebook_ad_account_id/facebook-pages --header 'Accept: application/json' --header 'Authorization: Bearer'

Path Parameters

[
  {
    "id": "460293477343848",
    "name": "360dialog"
  }
]

Get Facebook Ad Images

GET [signals-base-url]/v1/clients/{client_id}/apps/{app_id}/facebook-accounts/{facebook_account_id}/facebook-ad-accounts/{facebook_ad_account_id}/facebook-ad-images

Request Example

curl --request GET --url [base-url]/v1/clients/client_id/apps/app_id/facebook-accounts/facebook_account_id/facebook-ad-accounts/facebook_ad_account_id/facebook-ad-images --header 'Accept: application/json' --header 'Authorization: Bearer 122'

Ads Campaign Structure

Configuring Tracking Keywords

Best Practices

Analyzing Results

Signals Endpoints

Base-URL

Retrieve Client's Facebook Accounts IDs

Retrieve list of attached Facebook accounts of the client

Retrieve list of Ad accounts related to the client's Facebook account

Retrieve list of Ads related to client's Ad account

Query Parameters

Meta Ads

Get Ads

Path Parameters

Query Parameters

Get Ad

Path Parameters

Get Ads Insights

Path Parameters

Refresh Ads Insights

Path Parameters

Refresh Ad Insights

Path Parameters

Meta Campaigns

Get Campaigns

Path Parameters

Get Campaign

Path Parameters

Get Campaign Insights

Path Parameters

Refresh Campaigns Insights

Path Parameters

Refresh Campaign Insights

Path Parameters

Events

Create converted event

Path Parameters

Request Body

Get Events Types

Path Parameters

Query Parameters

Get Events

Path Parameters

Query Parameters

Export Events

Path Parameters

Query Parameters

Get Event Stats

Path Parameters

Get Events Groups

Path Parameters

Query Parameters

Creating an Ad Campaign

Facebook Account

Get Facebook Accounts

Path Parameters

Create Facebook Account

Path Parameters

Request Body

Get Facebook Ad Accounts

Path Parameters

Ad Campaign

Create Facebook Ad Campaign

Path Parameters

Request Body

Get Facebook Pages ID

Path Parameters

Get Facebook Ad Images

Path Parameters