Using advanced search with Ingenious Query Language (IQL)

Owned by Frank Schmidt
Last updated: Oct 06, 2021 by Benjamin Kuhn
3 min read

The advanced search allows you to build structured queries using the Ingenious Query Language (IQL) to search your data using APIs that support IQL.

IQL is not a database query language, even though it uses SQL-like syntax.

Parts of an IQL

Part

Examples

Description

Part

Examples

Description

Field (mandatory)

advertiser.name
partner.id

Field in the queried data on which this IQL (or part of it) operates

Operator

=

!=

IN

Comparison method of the fields value with the value presented in the IQL

Value

‘My Advertiser’

A constant value to compare the preceding field-data with using the given operator.

Conjunction (optional)

AND, OR

Allows the building of complex IQL by conjoining multiple IQL.

Constructing IQL queries

A basic IQL consists of a field followed by an operator followed by a value.

 

Examles:

Field Types

Each field has a data type defining what values it can be compared against as well as the operators that are allowed.

Type

Possible operators

Examples

Description

Type

Possible operators

Examples

Description

LONG

DOUBLE

EQUALS, NOT_EQUALS, LESS_THEN, LESS_OR_EQUAL, GREATER_THEN, GREATER_OR_EQUAL

7365362

1.816264

18162.64

Numeric values

DATE

DATE_TIME

EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL

'2020-05-07'

'2020-05-07T08:30'

Date / DateTime values in ISO 8601

STRING

IN, LIKE, ILIKE, EQUALS, NOT_EQUALS

'MyTestString'

Text

ENUM

EQUALS, NOT_EQUALS, IN

'ACTIVE'

String values from a list of available options.

Custom Types (ADVERTISER, PARTNER, …)

IN, LIKE, ILIKE, EQUALS, NOT_EQUALS

'76672'

Represents an object in Ingenious by its Identifier. Otherwise, behaves exactly like STRING.

Operators

Operator

Syntax

Syntax example

Description

Operator

Syntax

Syntax example

Description

LIKE

ILIKE

LIKE

ILIKE

advertiser.name LIKE '%Test'

Compares field data and value. The % sign can be used to match any character any number of times. The ‘LIKE’ operator matches case sensitive whereas the ‘ILIKE’ operator does not.

EQUALS

NOT_EQUALS

=

!=

advertiser.name = 'Test'

webhook.log.responseCode = 200

Field data and value for equality / inequality.

IN

IN

advertiser.name IN ('TEST', 'MyAdvertiser')

Checks whether the field's data is equal to any of the given values.

LESS_THEN

GREATER_THEN

GREATER_OR_EQUAL

LESS_OR_EQUAL

<

>

>=

<=

webhook.log.responseCode >= 200

advertiser_startDate < '2019-09-29T16:19'

Checks whether field data is greater, greater equal, less, less or equal than the value given.

CONTAINS

CONTAINS

advertiser.attributes CONTAINS ('BASKET_FREEZE', 'CREATIVE_IMAGE')

Checks that all given values are contained in the field data

Conjunctions

Conjunction

Example

Description

Conjunction

Example

Description

AND

advertiser.status = 'ACTIVE' AND advertiser.phase = 'TESTING'

Result must match both the left-hand and the right-hand part of the IQL

OR

advertiser.status = 'ACTIVE' OR advertiser.phase = 'TESTING'

Result must match either the left-hand or the right-hand part of the IQL

 

Iql Fields

Field

Type

Operators

Values

Field

Type

Operators

Values

adspace.category.id

ADSPACE_CATEGORY

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

adspace.id

ADSPACE

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

adspace.name

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

adspace.subcategory.id

ADSPACE_SUB_CATEGORY

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

adspace.website

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

advertiser.alias

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

advertiser.attributes

ENUM

[CONTAINS]

FIRST_PARTY_TRACKING,BASKET_FREEZE,NATIVE_MOBILE_TRACKING,METADATA_TRACKING,CLICK_ID_TRACKING,BOUNCELESS_TRACKING,MULTI_TOUCH_ATTRIBUTION,PRODUCT_DATA_FEED,VOUCHER,DEEPLINK,CREATIVE_TEXT,CREATIVE_IMAGE,CREATIVE_IMAGE_HOSTED,CREATIVE_HTML,POST_VIEW_COMMISSION,POST_CLICK_COMMISSION

advertiser.billingData.companyName

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

advertiser.billingData.email

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

advertiser.billingData.externalReferenceNumber

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

advertiser.billingData.vatId

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

advertiser.categoryId

ADVERTISER_CATEGORY

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

advertiser.id

ADVERTISER

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

advertiser.labels

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

advertiser.name

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

advertiser.phase

ENUM

[EQUALS, NOT_EQUALS, IN]

TESTING,PHASE_OUT,PHASE_OUT_ONLY_CONVERSIONS

advertiser.promotionCountryCodes

COUNTRY

[CONTAINS]

-

advertiser.shortDescription

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

advertiser.startDate

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

advertiser.status

ENUM

[EQUALS, NOT_EQUALS, IN]

ACTIVE,DEACTIVATED,DELETED

advertiser.trackingId

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

advertiser.website

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

commissionModel.default

ENUM

[EQUALS, IN]

TRUE,FALSE

commissionModel.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

commissionModel.name

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

commissionModel.status

ENUM

[EQUALS, NOT_EQUALS, IN]

ACTIVE,INACTIVE,DELETED

commissionRule.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

commissionRule.name

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

commissionRule.status

ENUM

[EQUALS, NOT_EQUALS, IN]

ACTIVE,INACTIVE,DELETED

conversion.conversionId

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

conversion.createdAt

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

conversion.documentId

LONG

[EQUALS, NOT_EQUALS, LESS_THEN, LESS_OR_EQUAL, GREATER_THEN, GREATER_OR_EQUAL]

-

conversion.status

ENUM

[EQUALS, NOT_EQUALS, IN]

OPEN,APPROVED,REJECTED,CONFIRMED

conversion.touchpoint.subId1

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

conversion.touchpoint.subId2

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

conversion.touchpoint.subId3

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

conversion.touchpoint.subId4

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

conversion.touchpoint.subId5

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

conversion.touchpoint.subId6

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

conversion.uniqueId

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

conversionExport.createdAt

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

conversionExport.requestExportUniqId

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

conversionExport.status

ENUM

[EQUALS, NOT_EQUALS, IN]

PENDING,PROCESSED,FAILED

conversionImport.createdAt

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

conversionImport.requestImportUniqId

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

conversionImport.status

ENUM

[EQUALS, NOT_EQUALS, IN]

UPLOADED,VALIDATED,ACCEPTED,CANCELLED,PROCESSED

conversionTarget.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

conversionTarget.name

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

conversionTarget.status

ENUM

[EQUALS, NOT_EQUALS, IN]

ACTIVE,INACTIVE

creative.bannerId

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

creative.code

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

creative.createdAt

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

creative.description

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

creative.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

creative.imageFormat

ENUM

[EQUALS, NOT_EQUALS, IN]

Custom,MediumRectangle,SquarePopUp,WideSkyscraper,VerticalRectangle,LargeRectangle,Rectangle,Rectangle3To1,PopUnder,FullBanner,HalfBanner,MicroBar,Button1,Button2,VerticalBanner,SquareButton,Leaderboard,Skyscraper,HalfPageAd

creative.name

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

creative.status

ENUM

[EQUALS, NOT_EQUALS, IN]

ACTIVE,INACTIVE,HIDDEN,DELETED

creative.targetUrl

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

creative.type

ENUM

[EQUALS, NOT_EQUALS, IN]

IMAGE_REMOTE,IMAGE_HOSTED,HTML,LINK

creative.updatedAt

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

creativeSet.code

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

creativeSet.createdAt

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

creativeSet.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

creativeSet.name

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

creativeSet.status

ENUM

[EQUALS, NOT_EQUALS, IN]

ACTIVE,INACTIVE,HIDDEN,DELETED

creativeSet.updatedAt

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

entity.companyName

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

entity.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

entity.lastChanged

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

entity.status

ENUM

[EQUALS, NOT_EQUALS, IN]

ACTIVATED,DELETED

feeModel.default

ENUM

[EQUALS, IN]

TRUE,FALSE

feeModel.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

feeModel.name

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

feeModel.status

ENUM

[EQUALS, NOT_EQUALS, IN]

ACTIVE,INACTIVE,DELETED

feed.actionStatus

ENUM

[EQUALS, NOT_EQUALS, IN]

ACTIVE,DEACTIVATED,DELETED,FAILED

feed.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

feed.status

ENUM

[EQUALS, NOT_EQUALS, IN]

ACTIVE,DEACTIVATED,DELETED,FAILED

job.createdAt

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

job.executionEndDateTime

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

job.executionLog

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

job.executionStartDateTime

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

job.executionStatus

ENUM

[EQUALS, NOT_EQUALS, IN]

PLANNED,SUCCEEDED,FAILED

job.executionTransferedBytes

LONG

[EQUALS, NOT_EQUALS, LESS_THEN, LESS_OR_EQUAL, GREATER_THEN, GREATER_OR_EQUAL]

-

job.executionTransferedTotal

LONG

[EQUALS, NOT_EQUALS, LESS_THEN, LESS_OR_EQUAL, GREATER_THEN, GREATER_OR_EQUAL]

-

job.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

job.schedulePlannedDateTime

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

job.status

ENUM

[EQUALS, NOT_EQUALS, IN]

ACTIVATED,DEACTIVATED,DELETED

job.type

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

job.updatedAt

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

network.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

partner.companyName

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

partner.firstName

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

partner.id

PARTNER

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

partner.lastName

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

relationship.adspaceId

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

relationship.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

relationship.lastChanged

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

relationship.status

ENUM

[EQUALS, NOT_EQUALS, IN]

APPLIED,ACTIVE,DEACTIVATED,DELETED,NOT_APPLIED

request.createdAt

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

request.status

ENUM

[EQUALS, NOT_EQUALS, IN]

INQUIRED,ACCEPTED,REJECTED,PROCESSED,CANCELLED,FAILED

request.type

ENUM

[EQUALS, NOT_EQUALS, IN]

CREATE_NEW,CHANGE_EXISTING

request.uniqueId

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

trackingCategory.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

trackingCategory.name

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

trackingCategory.status

ENUM

[EQUALS, NOT_EQUALS, IN]

ACTIVE,DELETED,PAUSED,ENDED

user.alias

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

user.email

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

user.firstName

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

user.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

user.lastName

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

user.status

ENUM

[EQUALS, NOT_EQUALS, IN]

ACTIVATED,DEACTIVATED,DELETED

user.type

ENUM

[EQUALS, NOT_EQUALS, IN]

PARTNER,AGENCY,PLATFORM

webhook.log.code

ENUM

[EQUALS, NOT_EQUALS, IN]

UNKNOWN,EXECUTED,FAILED,UNKNOWN_TEMPLATE_PARAMETER_USED,SKIPPED_UNSUPPORTED_TRANSITION,SKIPPED_STATUS_CHANGE_WITHOUT_STATUS_PLACEHOLDER_IN_CODESET,SKIPPED_DISPLAY_MODE_ADVERTISER_ONLY

webhook.log.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

webhook.log.lastChanged

DATE_TIME

[EQUALS, NOT_EQUALS, GREATER_OR_EQUAL, GREATER_THEN, LESS_THEN, LESS_OR_EQUAL]

-

webhook.log.message

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

webhook.log.responseCode

LONG

[EQUALS, NOT_EQUALS, LESS_THEN, LESS_OR_EQUAL, GREATER_THEN, GREATER_OR_EQUAL]

-

webhook.log.status

ENUM

[EQUALS, NOT_EQUALS, IN]

SUCCEEDED,FAILED,SCHEDULED

webhook.replacements.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

webhook.replacements.name

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

webhook.rule.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

webhook.rule.name

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

webhook.targetConfiguration.id

STRING

[IN, LIKE, ILIKE, EQUALS, NOT_EQUALS]

-

webhook.targetConfiguration.name

STRING

[LIKE, ILIKE, EQUALS, NOT_EQUALS]

-