Skip to main content

EasyPromos Data Source

The EasyPromos connector enables you to ingest promotion data, participant records, participation history, prize assignments, coin balances, and ranking information from your EasyPromos account. Follow the instructions below to create a new data flow that ingests data from an EasyPromos source in Nexla.
easypromos_api.png

EasyPromos

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the EasyPromos connector tile from the list of available connectors. Then, select the credential that will be used to connect to the EasyPromos instance, and click Next; or, create a new EasyPromos credential for use in this flow.

  3. In Nexla, EasyPromos data sources can be created using pre-built endpoint templates, which expedite source setup for common EasyPromos endpoints. Each template is designed specifically for the corresponding EasyPromos endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    EasyPromos sources can also be configured manually, allowing you to ingest data from EasyPromos endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common EasyPromos endpoints. Each template is designed specifically for the corresponding EasyPromos endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

List Promotions

Returns a paginated list of all promotions in your EasyPromos account. Use this endpoint to retrieve a full inventory of your campaigns, optionally filtered by status (e.g., active, inactive, or draft).

  • In the Status field, optionally enter a status value to filter the results. Accepted values include active, inactive, and draft. Leave this field empty to retrieve promotions in all statuses.
  • In the Order field, optionally specify the field by which results should be sorted (e.g., created_at or name). Leave this field empty to use the default sort order.

This endpoint uses cursor-based pagination, so Nexla will automatically retrieve all pages of results. The response data path is $.items[*], and pagination is managed via the next_cursor field in the $.paging object.

Get Promotion

Retrieves the full details of a single promotion identified by its unique ID. Use this endpoint when you need metadata and configuration details for a specific campaign.

  • In the Id field, enter the unique identifier of the promotion you want to retrieve. You can find promotion IDs by first running the List Promotions endpoint.

This endpoint returns a single promotion object. The response data path is set to $ (the root of the response).

List Organizing Brands

Returns a paginated list of all organizing brands associated with your EasyPromos account. Organizing brands are entities (companies or brands) that own and run promotions within your account.

  • In the Order field, optionally specify the field by which results should be sorted. Leave this field empty to use the default sort order.

This endpoint uses cursor-based pagination. Nexla automatically retrieves all pages of results using the next_cursor field in the response.

Get Organizing Brand

Retrieves the details of a single organizing brand by its unique ID. Use this endpoint to access configuration and metadata for a specific brand within your EasyPromos account.

  • In the Id field, enter the unique identifier of the organizing brand you want to retrieve. You can find brand IDs by first running the List Organizing Brands endpoint.

List Brand Promotions

Returns a paginated list of promotions belonging to a specific organizing brand, with optional filtering by status. Use this endpoint when you need to scope your promotion data to a single brand.

  • In the Brand Id field, enter the unique identifier of the organizing brand whose promotions you want to retrieve. You can find brand IDs using the List Organizing Brands endpoint.
  • In the Status field, optionally enter a status value to filter results. Accepted values include active, inactive, and draft.
  • In the Order field, optionally specify the field by which results should be sorted.

This endpoint uses cursor-based pagination. Nexla will automatically retrieve all result pages.

List Participation Stages

Returns a list of all participation stages within a promotion. Stages define the individual steps or activities that participants must complete within a multi-step campaign. Use this endpoint to retrieve stage configuration and activity definitions for a promotion.

  • In the Id field, enter the unique identifier of the promotion whose stages you want to list.
  • In the Order field, optionally specify the field by which results should be sorted.
  • In the Segments field, optionally filter stages by specific audience segments.
  • In the Active field, optionally filter by active status. Enter true to return only active stages or false to return inactive stages.

This endpoint uses cursor-based pagination. Nexla automatically retrieves all pages of results.

Get Participation Stage

Retrieves complete data for a single participation stage within a promotion. Use this endpoint when you need the full configuration and requirements for a specific stage.

  • In the Promotion Id field, enter the unique identifier of the promotion that contains the stage.
  • In the Id field, enter the unique identifier of the participation stage to retrieve.

List Promotion Users

Returns a paginated list of all users registered in a promotion, with optional filtering by registration status. Use this endpoint to retrieve your full participant list for a campaign.

  • In the Id field, enter the unique identifier of the promotion whose users you want to list.
  • In the Status field, optionally filter by participant status. Accepted values include pending, confirmed, and rejected.
  • In the Order field, optionally specify the field by which results should be sorted.

This endpoint uses cursor-based pagination. Nexla automatically retrieves all pages of results using the next_cursor field in the $.paging object.

Get Promotion User

Retrieves all data for a single user registered in a specific promotion. Use this endpoint when you need the complete profile and activity record of an individual participant.

  • In the Promotion Id field, enter the unique identifier of the promotion.
  • In the Id field, enter the unique identifier of the promotion user you want to retrieve.

Get User Login Token

Retrieves the login token for a specific user registered in a promotion. Login tokens are used to authenticate users for operations such as submitting participations, checking eligibility, and managing segments on their behalf.

  • In the Promotion Id field, enter the unique identifier of the promotion.
  • In the User Id field, enter the unique identifier of the user whose login token you want to retrieve.

The login token returned by this endpoint is required as the lt parameter for several write-oriented EasyPromos endpoints, including segment assignment, participation submission, and eligibility checks. Retrieve the token here before configuring those destination endpoints.

List participations for a promotion

Returns a paginated list of all participation records for a promotion. Use this endpoint to retrieve the complete participation history for a campaign, including submitted entries and their associated data.

  • In the Promotion ID field, enter the unique identifier of the promotion whose participation records you want to retrieve.
  • In the Order field, optionally specify a sort field for the results.
  • In the Format field, optionally specify the response format for participation data.

This endpoint uses cursor-based pagination. Nexla automatically retrieves all pages of results.

List participations for a user

Returns a paginated list of all participations submitted by a specific user within a promotion. Use this endpoint when you need a per-user participation history within a given campaign.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the User ID field, enter the unique identifier of the user whose participation history you want to retrieve.
  • In the Order field, optionally specify a sort field for the results.

This endpoint uses cursor-based pagination. Nexla automatically retrieves all pages of results.

Get a participation

Retrieves the complete details of a single participation record. Use this endpoint when you need to inspect the full data submitted for a specific participation entry.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the Participation ID field, enter the unique identifier of the participation record you want to retrieve.

Get remaining participations for a user

Retrieves the remaining participation count available to a specific user within a particular promotion stage. Use this endpoint to check how many more times a user can participate before reaching the stage limit.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the Stage ID field, enter the unique identifier of the promotion stage for which you want to check the remaining count.
  • In the User ID field, enter the unique identifier of the user to check.

List assigned prizes and winners

Returns the complete list of all assigned prizes and their corresponding winners for a promotion. Use this endpoint to retrieve prize distribution records, verify winner assignments, or export results for reporting purposes.

  • In the Promotion ID field, enter the unique identifier of the promotion whose prize and winner data you want to retrieve.

This endpoint uses cursor-based pagination. Nexla automatically retrieves all pages of results. For additional details, refer to the EasyPromos Prizes API documentation.

Get user prizes

Returns all prizes won by a specific user in a promotion. Use this endpoint to retrieve a single participant's complete prize history within a campaign.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the User ID field, enter the unique identifier of the user whose prizes you want to retrieve.

For additional details, refer to the EasyPromos Prizes API documentation.

Get prize inventory

Returns prize inventory details including current stock levels for a promotion. Use this endpoint to monitor prize availability and ensure that sufficient inventory exists before distributing rewards.

  • In the Promotion ID field, enter the unique identifier of the promotion whose prize inventory you want to retrieve.

For additional details, refer to the EasyPromos Prizes API documentation.

Get user coin balance

Returns the current virtual coin balance for a specific user in a promotion. EasyPromos supports virtual coin economies within gamified campaigns, allowing users to earn and spend coins based on their participation. Use this endpoint to retrieve a user's current balance.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the User ID field, enter the unique identifier of the user whose coin balance you want to retrieve.

For additional details, refer to the EasyPromos Coins API documentation.

List user coin transactions

Returns the complete list of virtual coin transactions for a specific user in a promotion. Use this endpoint to audit a user's coin earning and spending history within a gamified campaign.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the User ID field, enter the unique identifier of the user whose coin transaction history you want to retrieve.

For additional details, refer to the EasyPromos Coins API documentation.

List promotion coin transactions

Returns the complete list of all virtual coin transactions across all users in a promotion. Use this endpoint to get a full audit trail of coin activity for an entire campaign.

  • In the Promotion ID field, enter the unique identifier of the promotion whose coin transactions you want to retrieve.

For additional details, refer to the EasyPromos Coins API documentation.

Get promotion ranking

Returns the leaderboard ranking of users in a promotion based on their performance metrics (such as coin totals, participation counts, or other campaign-specific scoring). Use this endpoint to retrieve ranking data for display or downstream analysis.

  • In the Promotion ID field, enter the unique identifier of the promotion whose ranking data you want to retrieve.

For additional details, refer to the EasyPromos Rankings API documentation.

List points of sale

Returns the list of all points of sale associated with a promotion. Points of sale are physical or virtual retail locations linked to a campaign for location-based promotions or in-store redemption workflows.

  • In the Promotion ID field, enter the unique identifier of the promotion whose points of sale you want to retrieve.

For additional details, refer to the EasyPromos Points of Sale API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

EasyPromos data sources can be manually configured to ingest data from any valid EasyPromos API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex EasyPromos sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the EasyPromos API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions

API Endpoint URL​

  1. Enter the URL of the EasyPromos API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. The base URL for the EasyPromos API is https://api.easypromos.com.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. For a full list of available EasyPromos API endpoints, refer to the EasyPromos API 2.0 reference.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Macros are particularly useful for EasyPromos endpoints that accept date range parameters, allowing you to automatically retrieve only data from recent time windows rather than fetching the full historical dataset on every run.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when building EasyPromos sources that need to iterate over a set of promotion IDs or user IDs retrieved from another Nexla data source, automatically constructing endpoint URLs for each item.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by an API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when EasyPromos API responses contain pagination metadata or other envelope data that you don't need for analysis.

For example, when retrieving a list of promotions or participants, the EasyPromos API typically returns an array of records nested under an items key along with pagination information under a paging key. By specifying the path $.items[*], you can configure Nexla to treat each element of the items array as an individual record.

Path to Data is essential when EasyPromos API responses have nested structures. Without specifying the correct path, Nexla may not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. For example, use $.items[*] for paginated list endpoints or $ for single-object endpoints.
    Path to Data Example:

    EasyPromos list endpoints (such as List Promotions or List Promotion Users) return records nested under an items key. Enter $.items[*] as the path to data to extract each item as an individual record. For single-object endpoints (such as Get Promotion), the response is a single JSON object, so use $ as the path.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. For EasyPromos paginated endpoints, pagination context such as total counts or cursor values is located in the paging object outside the items array. Specifying a path to this metadata allows you to preserve that context with each record.

Metadata paths are particularly useful for preserving EasyPromos response context like the next_cursor value or total record counts that appear alongside the main data array.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata. For example, enter $.paging to include EasyPromos pagination metadata with each record.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers may be needed for API versioning or custom EasyPromos configurations.

    You do not need to include the Authorization header here — it is automatically applied by Nexla using the API Key configured in your EasyPromos credential.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new EasyPromos data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.