Cint Exchange Feed Opportunities and Respondent Outcomes FAQs

Prev Next

This article addresses frequently asked questions regarding our feed products (Opportunities and Respondent Outcomes), formerly known as on-time-supply or ots.

Please note: This article has been updated to reflect our latest pricing model, replacing cost per interview (CPI) with revenue per interview (RPI) metrics. We will be working closely with our supply partners to transition them to the RPI model. If you have not yet migrated to RPI and require access to documentation containing CPI details, please contact your account team, who can provide the relevant materials.


General background and information

What is feed?

Feed (formerly known as on-time-supply or ots) is a next-generation API subscription that enables our supply partners to make faster, more accurate decisions, improving their brand and respondent experience in the Cint Exchange.

  • Opportunities pushes survey information including, qualifications and quota data in near real-time for all surveys in an opportunity watch list.

  • Respondent Outcomes in the Cint Exchange provides key data on the outcome of a respondent session, making it easy to track the performance of your integration and users.

Who is it for?

Feed is most effective for customers who have an existing supply API integration with Cint or net-new customers who are open to completing an enterprise-level integration with Cint.

Customers who access the Cint Exchange through match or another type of integration should speak to their customer success representative to see if it is the right fit for them, or email info@cint.com if they aren’t sure who to speak to.

How does a feed product benefit me?

Feed does the hard work of pulling information from the Cint system, and pushing it to our partners in one message. This all happens in near real-time, allowing users to make faster, more accurate decisions for their audience and get them to the right surveys at the right time.

How much does it cost?

Feed is a free for all Cint supply customers.

How does it help my customers?

By giving our partners more data, much quicker, feed empowers them to make more accurate decisions to put their users into better, more relevant surveys. This means their community of respondents will have a greatly improved survey experience.

What do I need to do or know to use it?

Our developer docs can be viewed here. However, feed is only suitable for partners who have good technical resources, and are comfortable working with webhooks. If you aren’t sure if feed is right for you, reach out to your customer success representative, or email info@cint.com if you aren’t sure who to speak to.

How long will it take to get set up?

Getting setup with feed can be done quickly and easily, but the timeline will vary depending on your situation. We recommend speaking to your customer success representative to get a personalized answer or contact us by emailing info@cint.com.

Who do I contact to get assistance setting feed up?

Our partners can discuss feed with their customer success representative. They will be able toadvise if feed is the right fit and help you get our partners set up.

Who do I contact to get assistance once feed is set up?

Our integration consultants and customer success representatives will be available to provide any support you need.


General technical information

What are the corresponding supply legacy parameters that match to feed

New property

Legacy property

survey_id

SurveyNumber

survey_name

SurveyName

account_name

AccountName

country_language

CountryLanguageID

industry

IndustryID

study_type

StudyTypeID

bid_length_of_interview

BidLengthOfInterview

bid_incidence

BidIncidence

collects_pii

CollectsPII

survey_group_ids

SurveyGroupID

survey_quota_calc_type

SurveyQuotaCalcTypeID

is_only_supplier_in_group

IsOnlySupplierInGroup

revenue_per_interview

CPI

total_remaining

TotalRemaining

completion_percentage

CompletionPercentage

conversion

Conversion

length_of_interview

LengthOfInterview

overall_completes

OverallCompletes

termination_length_of_interview

TerminationLengthOfInterview

mobile_conversion

SurveyMobileConversion

revenue_per_click

EPC or earnings_per_click

What is the feed retry logic when message delivery fails to my callback URL?

If we cannot deliver a message or your server returns a non-2xx status code, our system will retry for up to 24 hours using an exponential back-off strategy.

  • If we receive a successful response, you will be sent the latest available update.

  • If delivery of a message remains unsuccessful after 24 hours, your subscription will be deleted, regardless of whether other messages were successfully delivered during that period.

In the unlikely event of a Cint system outage, once systems are restored, you will receive the last saved message for each survey ID.

For details on what happens if we are unable to deliver messages related to deactivated surveys before subscription deletion, please refer to the next section.

What event handling best practices do you recommend for my feed subscription?

Acknowledge messages with a 2XX response immediately, prior to any post-processing you may do on your end. This will ensure that we do not think the message delivery failed.

If my subscription is deactivated due to failures, will I receive missed updates for deactivated surveys when I restart my Opportunities subscription?

No. If a subscription is deleted due to failed requests, any missed updates related to survey deactivations will not be resent. When you restart your subscription, you will only receive message bursts for active surveys that meet your subscription criteria.

You should deactivate any surveys for which you do not receive an update in your new stream. You can also identify active surveys—those allocated or with an entry link created—by calling our inventory endpoint. Additionally, we recommend implementing logic to automatically deactivate a survey in your database if you receive an initial (prescreener) status of 42 (survey closed) via your redirects or Respondent Outcomes subscription.

See overquotas terminations guide for more information.

Can I create multiple subscriptions?

No, at this stage suppliers can only create one subscription for opportunities and one for outcomes. However, multiple operators are available to build out complex and nested subscriptions.

I'm not receiving messages—what could be the problem?

There are several reasons why your webhook subscription might not be working. Below are common areas to troubleshoot. It is recommended to have an internal notification system in place to alert you when a message's status returns a non-2xx response.

  • Validate your callback URL: Run a GET show an opportunity subscription or show an outcomes subscription request to confirm your callback URL is correct.

  • Check SSL installation: Ensure your destination server has SSL installed.

  • Review subscription filter criteria: Verify that your filter criteria is using the correct arguments and formatting. A member of your account team can assist with this.

  • Confirm expected payload structure: Recheck the example payload in our API documentation to ensure your servers are correctly configured to process the information. If needed, your account team can provide an example response.

  • Check for system filters blocking requests: Have you created any filters that could be rejecting messages? For example, if your system blocks surveys with a study_type of "recontact", but your subscription criteria does not explicitly exclude these, any messages containing recontact surveys will fail.

  • Verify webhook security authentication: If implementing our authentication, ensure it is configured correctly and as per our documentation.

  • Assess server capacity: Confirm that your servers can handle the frequency and size of incoming messages. For Opportunities, you can adjust survey data frequency, payload size, and the number of surveys received by configuring specific arguments in your subscription.

    • Surveys, especially in the US, may include large qualification or quota pre-code selections based on regional targeting (e.g. zip codes). These selections can result in the survey_quotas and/or questions model exceeding 10,000 rows. Ensure that your system is capable of handling these scenarios.

  • Check for firewall restrictions: Ensure that firewalls are not blocking or delaying webhook requests.

  • Review timeout settings: Make sure your system allows sufficient time to process incoming messages.


Feed Respondent Outcomes

What are some subscription options I can use to understand respondent outcomes in the Cint Exchange?

Below are some example subscriptions. These subscriptions are only a sample of the possibilities and represent some common use cases.

See the marketplace response codes and client response codes articles for more information.

  1. If you would like to receive a message each time a respondent terminates on a Cint survey protection services or link manipulation response code or is reconciled, use this subscription:

{
  "callback": "https://www.supplier-delivery-endpoint.com/api/outcomes",
  "outcomes":
    [
      {
        "client_status": {"in": [11, 26, 28, 35, 38, 134, 135]},
        "marketplace_status": {"in": [3, 32, 37, 131, 238, 240, 241]}
      }
    ]
}
  1. If you would like to receive a message each time a respondent is termed due to an overquota, is reconciled, or fails secure client callback, use this subscription:

{
  "callback": "https://www.supplier-delivery-endpoint.com/api/outcomes",
  "outcomes":
    [
      {
        "client_status": {"in": [40, 10, 26, 11, 28, 235]},
        "marketplace_status": {"in": [40, 41]}
      }
    ]
}
  1. If you would like to receive a message for all session outcomes, use this subscription:

{
  "callback": "https://www.supplier-delivery-endpoint.com/api/outcomes",
  "outcomes": 
    [
      {}
    ]
}

Will I always receive a PID and MID value in the respondent outcome response?

No, we do not provide a PID (panelist_id) or MID (session_id) if the respondent terminates on Cint Exchange (marketplace) response code 236, which indicates the user opted out on the consent form. These values will also not be returned if they were not provided in the user's entry link into our system.

Will I receive only one message per user session?

No. As the user navigates through the Cint Exchange, their session outcome may change, especially if they pass the prescreener checks and qualify for a survey. You should expect multiple messages related to a user's session and should store the last message received as the final outcome.


Feed Opportunities

Do I need to continue to call the offerwall endpoint for survey information and changes?

No, you will be receiving this information via Opportunities once you have created a subscription.

If I have a subscription to feed Opportunities, do I still need to make calls to the show an allocated survey endpoint to retrieve correct pricing?

No, survey pricing will be returned in the opportunity message.

Will feed Opportunities push updates for allocated surveys?

Yes, updates will be pushed for all live surveys where you have an allocation and meets the criteria specified in your subscription.

What is data property "message_reason"?

Click feed opportunities message reason to find out more.

What happens when I subscribe to feed Opportunities?

Once your subscription is activated, Cint will send all surveys that are currently live on the Cint Exchange that meet your criteria. As this could be a large number of surveys, you may receive multiple messages over a period of time that represents this 'setup'.

You will also begin to receive messages for new surveys, then messages for surveys that have changed, meeting your criteria.

How many surveys will be delivered with each burst? What will the size be?

By default, each callback message will be delivered every 15 seconds and will contain up to 1,000 surveys, with a maximum data size of 8 MB. You can adjust the frequency of message delivery, the size of the payload, and the number of surveys each callback message contains by setting filters in your Opportunities subscription. For detailed instructions on creating these filters, please refer to the arguments section of the Opportunities documentation.

Please note, if you are receiving data for our high-demand countries and set the payload filters to their minimum values, this could impact your ability to stay current with survey updates. After making any filter adjustments, please review your integration performance to ensure the changes have not negatively affected it.

What should I do if I have a system outage and miss events?

We don't currently have the ability for you to replay missed messages. You can relaunch your subscription to receive a fresh batch of data or simply wait for updates to appear.

What updates trigger an event? i.e. will each survey that results in the number of respondents changing result in a message being sent?

Any changes to the data that is included in feed Opportunities models will trigger an event. There are no limits, so for every complete that occurs, it will trigger a new message.

Our system is struggling to handle the size and frequency of messages, can we configure how often they are sent, and the size?

Yes, you can adjust the frequency of message delivery, the size of the payload, and the number of surveys each callback message contains by setting filters in your Opportunities subscription.

See the arguments section of the Opportunities documentation for more information.

Please note, if you are receiving data for our high-demand countries and set the payload filters to their minimum values, this could impact your ability to stay current with survey updates. After making any filter adjustments, please review your integration performance to ensure the changes have not negatively affected it.

How is the order of survey data impacted when a batch of survey opportunities are broken up due to size?

We always send the oldest surveys changes first, 1000 at a time. If a survey changes whilst it’s waiting the data is updated, but its place in the line is not, so the data in a packet is always the latest for a given survey. After a survey is sent if it changes again it goes to the end of the line. In practice after the initial burst, all changes get sent every 15 seconds. It is unusual to get over 1000 unique surveys that change in each 15 seconds interval.


Feed Opportunities including qualifications and quotas

Will adding qualification and quota data to the payload delay the initial burst of surveys and updates?

No delays to the burst will occur. However, if the payload of qualification and quota data is very large, the batches will be broken up and sent more frequently than the 15 sec updates. If the data is still executing it will wait before sending the next batch.

After updates happen to qualification or quota data, when would we receive a message?

Updates to qualification and quota data is the same as all other data, which is about a minute after the update is made.

Is any of the information currently received via the qualification and quota endpoints being deprecated?

Property names will move to snake_case and SurveyStatusCode and SurveyStillLive properties are being removed, these are shown on the quota call.

Is the qualification and quota endpoints being deprecated in the future, or will they remain?

Once our existing customers confirm they are using the new qualification and quota feature, we will deprecate these endpoints.

Do we receive the entire qualification or quota data set sent each time a change happens, or is it a delta?

The entire package of data is sent with each update.

Will there be changes to how subscriptions are created?

Yes, qualifications and quotas are an optional data set, requiring opt-in. You will need to include filter “include\_quotas”: true to enable qualifications and quotas data

Will every subscription have qualifications and quotas included in the payload or is it optional?

Optional. qualifications and quotas is an optional opt-in feature.