Skip to main content

Coupon

Provides TikTok Shop coupon details, including discount setup, spend thresholds, claim and redemption windows, usage limits, and status.

Select Account

Allows you to select the TikTok Shop account from where data will be retrieved.

  • Reload Accounts & Marketplaces:

    • Use this to refresh the connection list if you have recently added or updated in the app.gorillaroi.com

  • Click here to connect additional accounts:

    • Click here to open the Gorilla ROI app, where you can add, update, or manage your account connections.

Period

Period is not required for the Coupon dataset.
​

Metrics

  • Coupon ID

  • Title

  • Promo Code

  • Status

  • Display Type

  • Product Scope

  • Target Buyer Segment

  • Creation Source

  • Discount Type

  • Discount Percentage

  • Discount Amount

  • Discount Currency

  • Discount Max Amount

  • Threshold Type

  • Threshold Min Spend Amount

  • Claim Start Time

  • Claim End Time

  • Redemption Type

  • Redemption Start Time

  • Redemption End Time

  • Redemption Relative Days

  • Usage Redemption Limit

  • Usage Single Buyer Claim Limit

  • Usage Total Claim Limit

  • Create Time

  • Update Time

Group by

Not applicable for the Coupon dataset.

Filter

Results per Query: Select the maximum number of records (rows) returned in the output (e.g., 5, 10, 50, 100, 500, 1000).

Field: Select the field to filter by, such as:

  • Coupon ID (supports EQUALS or CONTAINS)

  • Promo Code (supports EQUALS or CONTAINS)

  • Status (All, Not Start, Ongoing, Expired, Deactivated)

  • Display Type (All, Regular, Live, Creator Exclusive, Chat, Promo Code)

Operator: Choose how the filter is applied:

  • EQUALS → Matches the exact value

  • CONTAINS → Matches partial values

Value: Enter or select the value for the chosen field. This can be:

  • Manual input (e.g., Coupon ID, Promo Code)

  • Dropdown selection (e.g., Status, Display Type)

Add Filter: Use Add Filter to apply multiple conditions within the same group.

Add Filter Group: Use Add Filter Group to create separate groups for advanced filtering.

Options

Replace Blank Values with 0 or N/A: Replaces empty or missing values with 0 or N/A (where applicable).

No Header Row: Removes the header row from the output.

Products with Data Only: Displays only products that have data, hiding those with no data or activity.

Sample output (partial view) showing selected datapoints

Did this answer your question?