Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Corrected per TW-1009

...

Name

Data Type

Required

Summary

Sample Filter Data

Sample Sort Data

loggedInOwnerId

Long

Yes

A valid Publisher IDDSP ID, or Buyer ID

&filters=loggedInOwnerId eq 12345


loggedInOwnerTypeId

Integer

Yes

One of the following integer values that indicates the account type of the issuing the request:


Type of Account

Value

Publisher

1

buyers

5

ATD/Buyer

7


&filters=loggedInOwnerTypeId eq 1


id

Long

No

SEARCH and SORT is supported.

Plain SEARCH is depreciated as we have a separate endpoint for it.

?filters=id gtEq 298&filters=id lt 301

For ascending order, use ?sort=id

For descending order, use ?
sort=--id

name

String

No

SEARCH and SORT is allowed in this field. 

?filters=name like test

when name search is used, we also search for dealId.

For ascending order, use ?sort=name

For descending order, use ?sort=-name

additionalInfo

String

No

Search deal by its message component.

SORT is depreciated for this field.

?filters=additionalInfo like test


status

Integer

No

SEARCH and SORT is allowed in this field. 

?filters=status eq 1

 For ascending order, use ?sort=status

For descending order, use ?sort=-status

auctionType

Integer

No

SEARCH and SORT is allowed in this field. 

?filters=auctionType eq 1

For ascending order, use ?sort=auctionType

For descending order, use ?
sort=
- auctionType

startDate

Date

No

SEARCH and SORT supported. BETWEEN attribute is not currently supported. But you can use filters like

?filters=startDate gtEq 2014-06-12T17:00:00Z&filters=startDate lt 2014-06-16T17:00:00Z.

?filters=startDate gtEq 2014-06-12T17:00:00Z&filters=startDate lt 2014-06-16T17:00:00Z.

?sort=-startDate

endDate

Date

No

SEARCH and SORT supported.

?filters=endDate gtEq 2014-06-12T17:00:00Z&filters=endDate lt 2014-06-16T17:00:00Z.


flooreCPMIntegerNoSEARCH and SORT supported.?filters=flooreCPM gt 1
channelTypeIntegerNoSEARCH is supported on this field?filters=channelType eq 6
dealCategoryIntegerNoSEARCH is supported on this field?filters=dealCategory eq 1

Sample Calls: 

https://appsapi.pubmatic.com/pmp/deals?view=summary&filters=loggedInOwnerId%20eq%2080&filters=loggedInOwnerTypeId%20eq%205&pageSize=2&filters=name+like+*PM-CLOM-8057*

https://appsapi.pubmatic.com/pmp/deals?view=summary&filters=loggedInOwnerId%20eq%2080&filters=loggedInOwnerTypeId%20eq%205&pageSize=2&filters=channelType+eq+6&filters=status+eq+1

https://appsapi.pubmatic.com/pmp/deals?view=summary&filters=loggedInOwnerId%20eq%2080&filters=loggedInOwnerTypeId%20eq%205&pageSize=2&filters=dealCategory+eq+1

...