ADNUNTIUS
  • Adnuntius Documentation
  • Adnuntius Advertising
    • Overview
    • Getting Started
      • Ad Server for Agencies
      • Ad Server for Publishers
    • User Interface Guide
      • Dashboards
      • Advertising
        • Advertisers
        • Orders
        • Line Items
        • Line Item Templates
        • Creatives
        • Library Creatives
        • Targeting
        • Booking Calendar
        • Reach Analysis
        • Smoothing
      • Inventory
        • Sites
        • Adunits
        • External Ad Units
        • Site Rulesets
        • Blocklists
        • Site Groups
        • Earnings Accounts
        • Ad Tag Generator
      • Reports and Statistics
        • The Statistics Defined
        • The 4 Impression Types
        • Templates and Schedules
        • Report Translations
      • Queries
        • Advertising Queries
        • Publishing Queries
      • Users
        • Users
        • Teams
        • Roles
        • Notification Preferences
        • User Profile
      • Design
        • Layouts and Examples
        • Marketplace Products
        • Products
        • Coupons
      • Admin
        • API Keys
        • CDN Uploads
        • Custom Events
        • Reference Data
        • Email Translations
        • Context Services
        • External Demand Sources
        • Data Exports
        • Tiers
        • Network
    • API Documentation
      • API Requests
      • Targeting object
      • API Filters
      • Endpoints
        • /adunits
        • /adunittags
        • /advertisers
        • /article2
        • /creativesets
        • /assets
        • /authenticate
        • /contextserviceconnections
        • /coupons
        • /creatives
        • /customeventtypes
        • /deliveryestimates
        • /devices
        • /earningsaccounts
        • /librarycreatives
        • /lineitems
        • /location
        • /orders
        • /reachestimate
        • /roles
        • /segments
        • /segments/upload
        • /segments/users/upload
        • /sitegroups
        • /sites
        • /sspconnections
        • /stats
        • /teams
        • /tiers
        • /users
    • Requesting Ads
      • Javascript
        • Requesting an Ad
        • Layout Support
        • Utility Methods
        • Logging Options
        • Prebid
      • HTTP
      • Cookieless Advertising
      • VAST
      • Open RTB
      • Recording Conversions
      • Prebid Server
      • Prebid
      • Android SDK
      • IOS SDK
    • Creative Guide
      • HTML5 Creatives
    • Page
  • Adnuntius Marketplace
    • Overview
    • Getting Started
      • For Network Owners
      • For Media Buyers
        • Marketplace Advertising
          • Advertisers
          • Orders
          • Line Items
          • Line Item Templates
          • Placements (in progress)
          • Creatives
            • High Impact Formats
          • Library Creatives
          • Booking Calendar
          • Reach Analysis
          • Targeting
          • Smoothing
      • For Publishers
        • Marketplace Inventory
          • Sites
          • Adunits
          • Site Groups
          • Rulesets (in progress)
          • Blocklists
          • Ad Tag Generator
        • Design
          • Layouts
          • Marketplace Products
  • Adnuntius Self-Service
    • Overview
    • Getting Started
    • User Interface Guide
    • Marketing Tips (Work in Progress)
  • Adnuntius Data
    • Overview
    • Getting Started
    • User Interface Guide
      • Segmentation
        • Triggers
        • Segments
        • Folders
      • Fields
        • Fields
        • Mappings
      • Queries
      • Admin
        • Users, Teams and Roles
        • Data Exports
        • Network
    • API documentation
      • Javascript API
        • User Profile Updates
        • Page View
        • User Synchronisation
        • Get user segments
      • HTTP API
        • /page
        • /visitor
        • /sync
        • /segment
      • Profile Fields
    • Segment Sharing
  • Adnuntius Connect
    • Integration Guide (Work in Progress)
      • Prebid - Google ad manager
      • Privacy GTM integration
      • Consents API
      • TCF API
    • UI Guide (Work in Progress)
      • Containers and Dashboards
      • Privacy (updates in progress)
      • Variables, Triggers and Tags
      • Integrations (in progress)
      • Prebid Configuration
      • Publish
  • Adnuntius Email Advertising
    • Getting Started
  • Other Useful Information
    • Macros for click tracker
    • Setup Adnuntius via prebid in GAM
    • Identification and Privacy
      • User Identification
      • Permission to use Personal Data (TCF2)
      • Data Collection and Usage
      • Am I Being Tracked?
    • Header bidding implementation
    • Adnuntius Slider
    • Whitelabeling
    • Firewall Access
    • Ad Server Logs
    • Send segments Cxense
    • Setup deals in GAM
    • Render Key Values in ad
    • Parallax for Ad server Clients
  • Troubleshooting
    • FAQs
    • How do I contact support?
    • Adnuntius System Status
  • Adnuntius High Impact
    • Publisher onboarding
    • High Impact configuration
    • Guidelines for High impact creatives
Powered by GitBook
On this page
  • Example Queries
  • Return all Ad Units with a name that contains "footer"
  • Return all Line Items that started delivering after 2021/01/01
  • Return all Line Items in a RUNNING or ENDED state
  • Full Parameter Description
  • Flags
  • Basic Filtering Parameters
  • Advanced where Clause
  • Advanced Timestamp where Clauses
  1. Adnuntius Advertising
  2. API Documentation

API Filters

This section describes how to include filters with your API queries. Examples usages are:

  • Returning all Ad Units with a name that contains "footer"

  • Returning all Line Items that started delivering after 2021/01/01

  • Returning all Line Items in a RUNNING or ENDED state

Example Queries

This introduces the filtering capabilities of the API with some concrete examples. A full description of all the available parameters is provided in the next section.

Return all Ad Units with a name that contains "footer"

This makes use of the filterBy and filterByLike query parameters.

https://api.adnuntius.com/api/v1/adunits?auth_token=TOKEN&filterBy=name&filterByLike=footer

Return all Line Items that started delivering after 2021/01/01

This makes use of the where query parameter.

https://api.adnuntius.com/api/v1/lineitems?auth_token=TOKEN&where=startedRunningDate>2021-01-01

Conditions can be added to the where clause by using the ; separator character. So if we wanted to search for Line Items that started delivering between 2021-01-01 and 2021-06-01 we could use:

https://api.adnuntius.com/api/v1/lineitems?auth_token=TOKEN&where=startedRunningDate>2021-01-01;startedRunningDate<2021-06-01

Return all Line Items in a RUNNING or ENDED state

This also makes use of the where query parameter, and introduces the in operator.

https://api.adnuntius.com/api/v1/lineitems?auth_token=TOKEN&where=executionState+in+RUNNING,ENDED

Likewise, you can also use a not in operator:

https://api.adnuntius.com/api/v1/lineitems?auth_token=TOKEN&where=executionState+not+in+RUNNING,ENDED

Full Parameter Description

Flags

The following flags are supported:

Flag
Description

includeActive

include objects with an ACTIVE state

includeInactive

include objects with an INACTIVE state

includeHidden

include objects with a HIDDEN state

excludeInvalid

exclude objects with validation warnings

onlyMine

only return objects that were created by the current API user

Basic Filtering Parameters

Flag
Description
Example

filterBy

the field name of the object

filterBy=name

filterByValue

an exact match on the filtered field value. Requires filterBy

filterBy=name&filterByValue=Campaign

filterByLike

a match on any values in the filtered field that contain the supplied string. Requires filterBy

filterBy=name&filterByLike=Camp

filterByNotLike

a match on any values in the filtered field that do NOT contain the supplied string. Requires filterBy

filterBy=name&filterByNotLike=Camp

excludeIfMissing

a non-null filter

excludeIfMissing=tierId

Advanced where Clause

You can chain multiple conditions together into a where clause using the following syntax:

where=CONDITION;CONDITION;CONDITION

where each CONDITION can be one of the following:

Condition
Example

Equals

name=Adnuntius

Not Equals

name!=Adnuntius

Greater Than

startDate>2021-01-01

Greater Than Or Equal to

startDate>=2021-01-01

Less Than

startDate<2021-01-01

Less Than Or Equal to

startDate<=2021-01-01

Is In

objectState+in+ACTIVE,INACTIVE

Is Not In

objectState+not+in+ACTIVE,INACTIVE

Is Null

description+is+null

Is Not Null

description+is+not+null

The where filter matches when ALL of the CONDITIONs are met.

Advanced Timestamp where Clauses

The following interval expressions are supported:

  • X minutes later

  • X minutes ago

  • 1 hour later

  • 1 hour ago

  • X hours later

  • X hours ago

  • 1 day later

  • 1 day ago

  • 1 month later

  • 1 month ago

  • X months later

  • X months ago

  • 1 year later

  • 1 year ago

  • X years later

  • X years ago

Where X is an integer > 0. The singular minute, hour, day, month and year are for convenience only. You can for example specify 1 hours ago, which is the same as 1 hour ago.

Last updated 3 years ago