Advertiser

Resource URL: https://api.atomx.com/v3/advertiser (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
id Integer No Id
state Enum No State INACTIVE
name String Yes Name
address String No Address
city String No City
zip String No Zip
budget Float No Budget 0
budget_editable Boolean No Budget editable 1
budget_mail_send Integer No Budget mail send 0
brokerfee Integer No Brokerfee 0
brokerfee_hidden Boolean No Brokerfee hidden 0
cpm_bid_as_dcpm Boolean No Cpm bid as dcpm 0
allowed_pricemodels Set No Allowed pricemodels. Any of “CPM”, “DCPM” CPM,DCPM
daily_budget_amount Float No Daily budget amount 0
daily_budget_per Integer No Daily budget per 86400
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
account_manager User No Users object that belongs to Advertiser.
country Country No Countrys object that belongs to Advertiser. 1
dsp Dsp No Dsps object that belongs to Advertiser.
network Network Yes Networks object that belongs to Advertiser.
profile Profile No Profiles object that belongs to Advertiser.
quickstats Quickstats No Quickstats for Advertiser.
conversion_pixels List No List of ConversionPixels that belongs to Advertiser.
segments List No List of Segments that belongs to Advertiser.
campaigns List No List of Campaigns that belongs to Advertiser.
creatives List No List of Creatives that belongs to Advertiser.
profiles List No List of Profiles that belongs to Advertiser.

App

Resource URL: https://api.atomx.com/v3/app
Available methods: GET

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
id Integer No Id
bundle String Yes Bundle
name String No Name
appstore Appstore No Appstores object that belongs to App. 0
category Category No Categorys object that belongs to App. 0
quickstats Quickstats No Quickstats for App.

Appstore

Resource URL: https://api.atomx.com/v3/appstore
Available methods: GET

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
id Integer No Id
name String Yes Name

BidAnalysisReason

Resource URL: https://api.atomx.com/v3/bid-analysis-reason
Available methods: GET

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
id Integer No Id
name String Yes Name
level Integer Yes Level

Browser

Resource URL: https://api.atomx.com/v3/browser
Available methods: GET

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
id Integer No Id
name String Yes Name

BlockReason

Resource URL: https://api.atomx.com/v3/block-reason
Available methods: GET

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
id Integer No Id
name String Yes Name

Campaign

Resource URL: https://api.atomx.com/v3/campaign (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
id Integer No Id
state Enum No State INACTIVE
name String No Name
start_at DateTime No Start at
end_at DateTime No End at
budget Float No Budget 0
pricemodel Enum Yes Pricemodel
bid Float Yes Bid
daily_budget_amount Float No Daily budget amount 0
daily_budget_per Integer No Daily budget per 86400
brokerfee Integer No Brokerfee
brokerfee_hidden Boolean No Brokerfee hidden
cpm_bid_as_dcpm Boolean No Cpm bid as dcpm
click_url String No Click url
budget_mail_send Integer No Budget mail send 0
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
advertiser Advertiser Yes Advertisers object that belongs to Campaign.
profile Profile No Profiles object that belongs to Campaign.
creatives List No List of Creatives that belongs to Campaign.
conversion_pixels List No List of ConversionPixels that belongs to Campaign.
quickstats Quickstats No Quickstats for Campaign.

City

Resource URL: https://api.atomx.com/v3/city
Available methods: GET

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
id Integer No Id
name String Yes Name
country Country Yes Countrys object that belongs to City.
zipcodes List No List of Zipcodes that belongs to City.

Creative

Resource URL: https://api.atomx.com/v3/creative (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
id Integer No Id
state Enum No State INACTIVE
types Set Yes Types. Any of “IFRAME”, “POPUP”, “POPUNDER”, “JAVASCRIPT”, “FAVICON”, “VAST_3_0”, “VAST_2_0”, “APP”, “NATIVE_1_2”
name String No Name
content_type Enum Yes Content type
md5 String No Md5
extension Enum No Extension
url String No Url
javascript Text No Javascript
html Text No Html
title String No Title
mopup String No Mopup
click_url String No Click url
size_bytes Integer No Size bytes
final_url String No Final url
https Boolean No Https False
audited_at DateTime No Audited at
checked_at DateTime No Checked at
quality_points Integer No Quality points 0
quality_score Integer No Quality score 0
description String No Description
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
attributes List No List of Attributess that belongs to Creative.
advertiser Advertiser Yes Advertisers object that belongs to Creative.
size Size Yes Sizes object that belongs to Creative.
category Category No Categorys object that belongs to Creative. 0
modified_by User No Users object that belongs to Creative.
quickstats Quickstats No Quickstats for Creative.
bans List No List of CreativeBans that belongs to Creative.
checks List No List of Checkss that belongs to Creative.
previews List No List of Previewss that belongs to Creative.

CreativeAttribute

Resource URL: https://api.atomx.com/v3/creative-attribute
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
iab Integer No Iab
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

CreativeAudit

Resource URL: https://api.atomx.com/v3/creative-audit
Available methods: GET

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
creative Creative Yes Creatives object that belongs to CreativeAudit.
network Network Yes Networks object that belongs to CreativeAudit.

CreativeBanReason

Resource URL: https://api.atomx.com/v3/creative-ban-reason
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
description Text Yes Description
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

CreativeBan

Resource URL: https://api.atomx.com/v3/creative-ban (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
url String No Url
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
reason Reason Yes Reasons object that belongs to CreativeBan.
creative Creative Yes Creatives object that belongs to CreativeBan.

CreativeCheck

Resource URL: https://api.atomx.com/v3/creative-check (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
url String Yes Url
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
creative Creative Yes Creatives object that belongs to CreativeCheck.

CreativePreview

Resource URL: https://api.atomx.com/v3/creative-preview (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
md5 String Yes Md5
size_bytes Integer No Size bytes 0
extension Enum No Extension PNG
check_id String No Check id
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
creative Creative Yes Creatives object that belongs to CreativePreview.

Category

Resource URL: https://api.atomx.com/v3/category
Available methods: GET

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
id Integer No Id
name String Yes Name
iab String Yes Iab

ConnectionType

Resource URL: https://api.atomx.com/v3/connection-type
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

ConversionPixel

Resource URL: https://api.atomx.com/v3/conversion-pixel (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
id Integer No Id
state Enum No State INACTIVE
name String Yes Name
duration Integer No Duration 86400
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
advertiser Advertiser Yes Advertisers object that belongs to ConversionPixel.

Country

Resource URL: https://api.atomx.com/v3/country
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
code String Yes Code
code3 String Yes Code3
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
isps List No List of Isps that belongs to Country.

Datacenter

Resource URL: https://api.atomx.com/v3/datacenter
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

Dma

Resource URL: https://api.atomx.com/v3/dma
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

Domain

Resource URL: https://api.atomx.com/v3/domain (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
alexa_rank Integer No Alexa rank 0
updated_at DateTime No Updated at 0000-00-00 00:00:00
attributes List No List of Attributess that belongs to Domain.
language Language Yes Languages object that belongs to Domain.
category Category No Categorys object that belongs to Domain. 0
quickstats Quickstats No Quickstats for Domain.

DomainAttribute

Resource URL: https://api.atomx.com/v3/domain-attribute
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

Dsp

Resource URL: https://api.atomx.com/v3/dsp (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
id Integer No Id
state Enum No State INACTIVE
name String Yes Name
address String No Address
city String No City
zip String No Zip
request_type Enum Yes Request type
request_gzip Boolean No Request gzip 0
qps Integer Yes Qps
url String Yes Url
notification_emails String No Notification emails
brokerfee Integer No Brokerfee 0
brokerfee_hidden Boolean No Brokerfee hidden 0
user_sync Boolean No User sync 0
user_sync_url String No User sync url
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
campaign Campaign Yes Campaigns object that belongs to Dsp.
country Country No Countrys object that belongs to Dsp. 1
datacenter Datacenter No Datacenters object that belongs to Dsp. 1
network Network Yes Networks object that belongs to Dsp.
profile Profile No Profiles object that belongs to Dsp.
quickstats Quickstats No Quickstats for Dsp.

DspResultType

Resource URL: https://api.atomx.com/v3/dsp-result-type
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

DeviceType

Resource URL: https://api.atomx.com/v3/device-type
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

Fallback

Resource URL: https://api.atomx.com/v3/fallback (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
id Integer No Id
state Enum No State INACTIVE
name String Yes Name
types Set No Types. Any of “IFRAME”, “POPUP”, “POPUNDER”, “JAVASCRIPT” IFRAME,POPUP,POPUNDER,JAVASCRIPT
html Text Yes Html
updated_at DateTime No Updated at 0000-00-00 00:00:00
site Site No Sites object that belongs to Fallback.
network Network No Networks object that belongs to Fallback.
size Size Yes Sizes object that belongs to Fallback.

Isp

Resource URL: https://api.atomx.com/v3/isp
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
countries List No List of Countrys that belongs to Isp.

Language

Resource URL: https://api.atomx.com/v3/language
Available methods: GET

Attribute Name Type Required Description Default
id String No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

Network

Resource URL: https://api.atomx.com/v3/network (Authentication required)
Available methods: GET, PUT

Attribute Name Type Required Description Default
id Integer No Id
state Enum No State INACTIVE
name String Yes Name
company_info String No Company info
address String No Address
city String No City
zip String No Zip
payment_details Text No Payment details
payment_terms Integer No Payment terms 60
paypal_email String No Paypal email
networks_revshare Integer No Networks revshare 100
managed_fee Float No Managed fee 0.015
ssp_fee Float No Ssp fee 0.0001
dsp_fee Float No Dsp fee 0.0001
buying_fee Integer No Buying fee 12
selling_fee Integer No Selling fee 12
budget Float No Budget 0
billing_emails String No Billing emails
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
account_manager User No Users object that belongs to Network.
country Country No Countrys object that belongs to Network. 1
profile Profile No Profiles object that belongs to Network.
seller_profile SellerProfile No SellerProfiles object that belongs to Network.
publishers List No List of Publishers that belongs to Network.
quickstats Quickstats No Quickstats for Network.
advertisers List No List of Advertisers that belongs to Network.
dsps List No List of Dsps that belongs to Network.
fallbacks List No List of Fallbacks that belongs to Network.
ssps List No List of Ssps that belongs to Network.

NetworkAdjustment

Resource URL: https://api.atomx.com/v3/network-adjustment (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
id Integer No Id
adjustment Float Yes Adjustment
date Date Yes Date
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
network Network Yes Networks object that belongs to NetworkAdjustment.

Notification

Resource URL: https://api.atomx.com/v3/notification
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
message Text Yes Message
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

OperatingSystem

Resource URL: https://api.atomx.com/v3/operating-system
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

Profile

Resource URL: https://api.atomx.com/v3/profile (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
id Integer No Id
name String Yes Name
impression_frequency_cap_amount Integer No Impression frequency cap amount 0
impression_frequency_cap_per Integer No Impression frequency cap per 86400
ip_impression_frequency_cap_amount Integer No Ip impression frequency cap amount 0
ip_impression_frequency_cap_per Integer No Ip impression frequency cap per 86400
domain_alexa_rank_filter Integer No Domain alexa rank filter 0
appstores_filter_action Enum No Appstores filter action EXCLUDE
apps_filter_action Enum No Apps filter action EXCLUDE
app_categories_filter_action Enum No App categories filter action EXCLUDE
cities_filter_action Enum No Cities filter action EXCLUDE
connection_types_filter_action Enum No Connection types filter action EXCLUDE
countries_filter_action Enum No Countries filter action EXCLUDE
device_types_filter_action Enum No Device types filter action EXCLUDE
dmas_filter_action Enum No Dmas filter action EXCLUDE
domains_filter_action Enum No Domains filter action EXCLUDE
domain_attributes_filter_action Enum No Domain attributes filter action EXCLUDE
domain_categories_filter_action Enum No Domain categories filter action EXCLUDE
ip_ranges_filter_action Enum No Ip ranges filter action EXCLUDE
isps_filter_action Enum No Isps filter action EXCLUDE
languages_filter_action Enum No Languages filter action EXCLUDE
networks_filter_action Enum No Networks filter action EXCLUDE
placements_filter_action Enum No Placements filter action EXCLUDE
placement_types_filter_action Enum No Placement types filter action EXCLUDE
publishers_filter_action Enum No Publishers filter action EXCLUDE
request_attributes_filter_action Enum No Request attributes filter action EXCLUDE
sites_filter_action Enum No Sites filter action EXCLUDE
sizes_filter_action Enum No Sizes filter action EXCLUDE
ssps_filter_action Enum No Ssps filter action EXCLUDE
states_filter_action Enum No States filter action EXCLUDE
times_filter_action Enum No Times filter action EXCLUDE
zipcodes_filter_action Enum No Zipcodes filter action EXCLUDE
sample_profile_percentage Float No Sample profile percentage 0
updated_at DateTime No Updated at 0000-00-00 00:00:00
sample_profile Sample\_profile No Sample\_profiles object that belongs to Profile.
advertiser Advertiser No Advertisers object that belongs to Profile.
network Network No Networks object that belongs to Profile.
dsp Dsp No Dsps object that belongs to Profile.
app_categories List No List of App\_categoriess that belongs to Profile.
apps List No List of Apps that belongs to Profile.
appstores List No List of Appstores that belongs to Profile.
cities List No List of Citys that belongs to Profile.
connection_types List No List of ConnectionTypes that belongs to Profile.
countries List No List of Countrys that belongs to Profile.
device_types List No List of DeviceTypes that belongs to Profile.
dmas List No List of Dmas that belongs to Profile.
domain_attributes List No List of DomainAttributes that belongs to Profile.
domain_categories List No List of Domain\_categoriess that belongs to Profile.
domains List No List of Domains that belongs to Profile.
isps List No List of Isps that belongs to Profile.
languages List No List of Languages that belongs to Profile.
networks List No List of Networks that belongs to Profile.
publishers List No List of Publishers that belongs to Profile.
placements List No List of Placements that belongs to Profile.
placement_types List No List of PlacementTypes that belongs to Profile.
request_attributes List No List of RequestAttributes that belongs to Profile.
sites List No List of Sites that belongs to Profile.
sizes List No List of Sizes that belongs to Profile.
ssps List No List of Ssps that belongs to Profile.
states List No List of States that belongs to Profile.
zipcodes List No List of Zipcodes that belongs to Profile.
browsers List No List of Browsers that belongs to Profile.
operating_systems List No List of OperatingSystems that belongs to Profile.
segments List No List of Segments that belongs to Profile.
times List No List of Timess that belongs to Profile.
ip_ranges List No List of Ip\_rangess that belongs to Profile.
campaigns List No List of Campaigns that belongs to Profile.

ProfileTimesFilter

Resource URL: https://api.atomx.com/v3/profile-times-filter (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
profile_id Integer Yes Profile id
start Integer Yes Start
end Integer Yes End
updated_at DateTime No Updated at 0000-00-00 00:00:00

ProfileIpRangesFilter

Resource URL: https://api.atomx.com/v3/profile-ip-ranges-filter (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
profile_id Integer Yes Profile id
start String Yes Start
end String Yes End
updated_at DateTime No Updated at 0000-00-00 00:00:00

ProfileOperatingSystemsFilter

Resource URL: https://api.atomx.com/v3/profile-operating-systems-filter (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
profile_id Integer Yes Profile id
action Enum No Action INCLUDE
version_major Integer No Version major 0
version_minor Integer No Version minor -1
version_op Enum No Version op >=
updated_at DateTime No Updated at 0000-00-00 00:00:00
operating_system OperatingSystem Yes OperatingSystems object that belongs to ProfileOperatingSystemsFilter.

ProfileSegmentsFilter

Resource URL: https://api.atomx.com/v3/profile-segments-filter (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
profile_id Integer Yes Profile id
action Enum No Action INCLUDE
age Integer No Age 0
age_op Enum No Age op >=
value Integer No Value 0
value_op Enum No Value op >=
updated_at DateTime No Updated at 0000-00-00 00:00:00
segment Segment Yes Segments object that belongs to ProfileSegmentsFilter.

ProfileBrowsersFilter

Resource URL: https://api.atomx.com/v3/profile-browsers-filter (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
profile_id Integer Yes Profile id
action Enum No Action INCLUDE
version_major Integer No Version major 0
version_minor Integer No Version minor -1
version_op Enum No Version op >=
updated_at DateTime No Updated at 0000-00-00 00:00:00
browser Browser Yes Browsers object that belongs to ProfileBrowsersFilter.

Publisher

Resource URL: https://api.atomx.com/v3/publisher (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
id Integer No Id
state Enum No State INACTIVE
name String Yes Name
email String No Email
address String No Address
city String No City
zip String No Zip
payment_details Text No Payment details
payment_terms Integer No Payment terms 30
revshare Integer No Revshare 100
revshare_hidden Boolean No Revshare hidden 0
conversion_callback_url String No Conversion callback url
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
account_manager User No Users object that belongs to Publisher.
country Country No Countrys object that belongs to Publisher. 1
network Network Yes Networks object that belongs to Publisher.
seller_profile SellerProfile No SellerProfiles object that belongs to Publisher.
ssp Ssp No Ssps object that belongs to Publisher.
quickstats Quickstats No Quickstats for Publisher.
sites List No List of Sites that belongs to Publisher.

Placement

Resource URL: https://api.atomx.com/v3/placement (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
id Integer No Id
state Enum No State INACTIVE
name String Yes Name
updated_at DateTime No Updated at 0000-00-00 00:00:00
site Site Yes Sites object that belongs to Placement.
quickstats Quickstats No Quickstats for Placement.

PlacementType

Resource URL: https://api.atomx.com/v3/placement-type
Available methods: GET

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
id Integer No Id
name String Yes Name
updated_at DateTime No Updated at 0000-00-00 00:00:00

PublisherAdjustment

Resource URL: https://api.atomx.com/v3/publisher-adjustment (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
id Integer No Id
adjustment Float Yes Adjustment
date Date Yes Date
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
publisher Publisher Yes Publishers object that belongs to PublisherAdjustment.

PriceModel

Resource URL: https://api.atomx.com/v3/price-model
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

RequestAttribute

Resource URL: https://api.atomx.com/v3/request-attribute
Available methods: GET

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
id Integer No Id
name String Yes Name
updated_at DateTime No Updated at 0000-00-00 00:00:00

ReportUpdate

Resource URL: https://api.atomx.com/v3/report-update
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
start DateTime Yes Start
end DateTime Yes End
reason Text Yes Reason
created_at DateTime No Created at CURRENT_TIMESTAMP

RequestType

Resource URL: https://api.atomx.com/v3/request-type
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

ResultType

Resource URL: https://api.atomx.com/v3/result-type
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

Site

Resource URL: https://api.atomx.com/v3/site (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
id Integer No Id
state Enum No State INACTIVE
name String Yes Name
is_toolbar Boolean No Is toolbar False
updated_at DateTime No Updated at 0000-00-00 00:00:00
domain Domain No Domains object that belongs to Site. 0
publisher Publisher Yes Publishers object that belongs to Site.
seller_profile SellerProfile No SellerProfiles object that belongs to Site.
quickstats Quickstats No Quickstats for Site.
placements List No List of Placements that belongs to Site.
fallbacks List No List of Fallbacks that belongs to Site.

SellerProfile

Resource URL: https://api.atomx.com/v3/seller-profile (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
id Integer No Id
name String Yes Name
minimum_internal_bid Float No Minimum internal bid 0
creative_quality_filter Integer No Creative quality filter 0
content_type_filter Set No Content type filter. Any of “IMAGE”, “FLASH”, “IFRAME”, “JAVASCRIPT”
networks_filter_action Enum No Networks filter action EXCLUDE
advertisers_filter_action Enum No Advertisers filter action EXCLUDE
campaigns_filter_action Enum No Campaigns filter action EXCLUDE
creative_attributes_filter_action Enum No Creative attributes filter action EXCLUDE
creative_categories_filter_action Enum No Creative categories filter action EXCLUDE
dsps_filter_action Enum No Dsps filter action EXCLUDE
updated_at DateTime No Updated at 0000-00-00 00:00:00
network Network No Networks object that belongs to SellerProfile.
publisher Publisher No Publishers object that belongs to SellerProfile.
advertisers List No List of Advertisers that belongs to SellerProfile.
campaigns List No List of Campaigns that belongs to SellerProfile.
dsps List No List of Dsps that belongs to SellerProfile.
networks List No List of Networks that belongs to SellerProfile.
creative_attributes List No List of CreativeAttributes that belongs to SellerProfile.
creative_categories List No List of Creative\_categoriess that belongs to SellerProfile.
ssp Ssp No Ssps object that belongs to SellerProfile.

Segment

Resource URL: https://api.atomx.com/v3/segment (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
id Integer No Id
state Enum No State INACTIVE
name String Yes Name
duration Integer Yes Duration
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
advertiser Advertiser No Advertisers object that belongs to Segment.
quickstats List No List of Quickstatss that belongs to Segment.

Size

Resource URL: https://api.atomx.com/v3/size
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
width Integer No Width
height Integer No Height
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

SspResultType

Resource URL: https://api.atomx.com/v3/ssp-result-type
Available methods: GET

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
id Integer No Id
name String Yes Name
updated_at DateTime No Updated at 0000-00-00 00:00:00

Ssp

Resource URL: https://api.atomx.com/v3/ssp (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
created_at DateTime No Created at CURRENT_TIMESTAMP
id Integer No Id
state Enum No State ACTIVE
name String Yes Name
address String No Address
city String No City
zip String No Zip
request_type Enum Yes Request type
openrtb_flavor Enum No Openrtb flavor NORMAL
need_final_url Boolean No Need final url False
max_bids Integer No Max bids 1
expire_after Integer No Expire after 60
win_is_client Boolean No Win is client False
create_sites_only Boolean No Create sites only False
network_delay Integer No Network delay 20
notification_emails String No Notification emails
revshare Integer No Revshare 100
revshare_hidden Boolean No Revshare hidden 0
user_sync Boolean No User sync 0
user_sync_url String No User sync url
pop_type Enum No Pop type NONE
updated_at DateTime No Updated at 0000-00-00 00:00:00
country Country No Countrys object that belongs to Ssp. 1
network Network Yes Networks object that belongs to Ssp.
default_placement_type Default\_placement\_type No Default\_placement\_types object that belongs to Ssp. 1
placement Placement Yes Placements object that belongs to Ssp.
seller_profile SellerProfile No SellerProfiles object that belongs to Ssp.
user User Yes Users object that belongs to Ssp.
publishers List No List of Publishers that belongs to Ssp.
quickstats Quickstats No Quickstats for Ssp.
suspicious List No List of Suspiciouss that belongs to Ssp.

SspSuspicious

Resource URL: https://api.atomx.com/v3/ssp-suspicious (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
rtb_publisher_id String Yes Rtb publisher id
rtb_site_id String No Rtb site id
reason String Yes Reason
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
ssp Ssp Yes Ssps object that belongs to SspSuspicious.

State

Resource URL: https://api.atomx.com/v3/state
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

Timezone

Resource URL: https://api.atomx.com/v3/timezone
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
official_name String Yes Official name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00

User

Resource URL: https://api.atomx.com/v3/user (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
id Integer No Id
state Enum No State ACTIVE
name String No Name
email String Yes Email
skype String No Skype
totp_secret String No Totp secret
password String No Password
password_counter Integer No Password counter 0
flags Set No Flags. Any of “CREATIVES”, “DOMAINS”, “WIKI”, “BILLING”, “PUBLISHERS”, “HIDDEN_ADMIN”, “NETWORKS”
notifications Set No Notifications. Any of “BUDGET_90”, “BUDGET_100”, “CREATIVE_AUDIT”, “CAMPAIGN_DEACTIVATED”, “ENTITY_ADDED” BUDGET_90,BUDGET_100,CREATIVE_AUDIT,CAMPAIGN_DEACTIVATED,ENTITY_ADDED
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
language Language No Languages object that belongs to User. en
timezone Timezone No Timezones object that belongs to User. 5

UserNetwork

Resource URL: https://api.atomx.com/v3/user-network (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
role Enum No Role READ
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
network Network Yes Networks object that belongs to UserNetwork.
user User Yes Users object that belongs to UserNetwork.

UserPublisher

Resource URL: https://api.atomx.com/v3/user-publisher (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
role Enum No Role READ
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
publisher Publisher Yes Publishers object that belongs to UserPublisher.
user User Yes Users object that belongs to UserPublisher.

UserAdvertiser

Resource URL: https://api.atomx.com/v3/user-advertiser (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
role Enum No Role READ
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
advertiser Advertiser Yes Advertisers object that belongs to UserAdvertiser.
user User Yes Users object that belongs to UserAdvertiser.

UserDsp

Resource URL: https://api.atomx.com/v3/user-dsp (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
role Enum No Role READ
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
dsp Dsp Yes Dsps object that belongs to UserDsp.
user User Yes Users object that belongs to UserDsp.

UserSsp

Resource URL: https://api.atomx.com/v3/user-ssp (Authentication required)
Available methods: GET, PUT, POST

Attribute Name Type Required Description Default
role Enum No Role READ
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
ssp Ssp Yes Ssps object that belongs to UserSsp.
user User Yes Users object that belongs to UserSsp.

Zipcode

Resource URL: https://api.atomx.com/v3/zipcode
Available methods: GET

Attribute Name Type Required Description Default
id Integer No Id
name String Yes Name
created_at DateTime No Created at CURRENT_TIMESTAMP
updated_at DateTime No Updated at 0000-00-00 00:00:00
country Country Yes Countrys object that belongs to Zipcode.
cities List No List of Citys that belongs to Zipcode.