FAQ

The following article describes common questions that arise during API integration.

What is the typical project creation flow?

Pre requisites

1. Call Lookup All Supported Countries to retrieve the list of supported countries and their IDs.

2. Call Lookup Questions by CountryID to retrieve available demographic targeting questions, answers, and their associated IDs.

Project creation

1. Call Create Project to create a project for the specified country.

2. Call Create Quota to create quotas for completes or clicks using demographic targeting criteria supported by the project country.

3. Ensure the respondent is redirected to Transaction Completion when they reach a DQ, OQ, or Complete status so the correct outcome is recorded.

4. Before going live, call Test Project URL to retrieve a test link and confirm that the full survey flow from entry through completion works as expected.

5. Optionally call Project Settings Update to configure additional project settings such as recontact lists.

6. Call Update Project to set the project status to LIVE or to update other project information.

7. Once the project has completed fielding, call Transaction Reconciliation to reconcile transactions for the project.

8. Call Update Project to set the project status to COMPLETE.

Other available APIs

1. Additional update APIs such as Update Quota are available.

2. Lookup APIs such as Get Project Info are also available.

I am done integrating in staging. What do I need to do to get production access?

Before production credentials can be issued, the integration must be verified in staging. Create at least one project in staging and share its prodege_project_id with Prodege. The project must meet the following criteria.

1. The project is set to LIVE.

2. The project contains at least one quota.

3. The project successfully redirects to a DQ status.

4. The project successfully redirects to a Complete status.

5. The project contains buyer_name.

6. Aggregate Conversion is passed using Update Aggregate Stats by Project.

7. Aggregate Completes is passed using Update Aggregate Stats by Project.

After these criteria are verified, you will also be asked to reconcile at least one transaction using Transaction Reconciliation and update the project status to COMPLETE.

When targeting by Age, is it better to list ages using OR or specify a range?

You may list each age using the OR operator. As a shorter option, you can use the BETWEEN operator to define a range by specifying only the first and last precodes.

Example targeting for ages 21 to 25.

{
  "question_id": 1,
  "operator": "BETWEEN",
  "precodes": [21, 25]
}

Is there a way to group surveys together?

Grouping projects is not currently supported. However, you can configure project level inclusions or exclusions.

For example, Project A can be set to exclude respondents who clicked into Project B or Project C.

To enable this behavior, set enable_project_participation to true in the Project Settings Update API. When enabled, the following parameters are required.

1. participation_ids The project IDs to include or exclude.

2. participation_status The transaction types to include or exclude. Valid values are 1 for click, 2 for complete, 4 for DQ, and 8 for OQ.

3. participation_filter_type Specifies whether the listed projects should be included or excluded.

We keep getting Error Code 101 Unauthorized. What are we doing wrong?

Error Code 101 indicates that the request signature may be incorrect. Instructions for generating the signature can be found at the request signing documentation.

When troubleshooting this issue, confirm the following.

1. All request parameters are sorted alphabetically before generating the signature.

2. Lookup Request Time Offset is called before each request to obtain the request_time_offset used to generate request_date.

3. POST data is sent using application x www form url encoded format.

4. The signature parameter itself is not included when generating the signature.