API Reference
Advertiser APIs HomeGuidesAPI ReferenceChangelog

List segment uploads

get
https://{buzz_key}.api.beeswax.com/rest/v2/segment-uploads

Returns a list of segment upload jobs for the current account. Segment uploads import user IDs to populate segments from files or S3 references.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
account_id__in
array of numbers

Multiple values may be separated by commas.

account_id__in
number
account_id__not_in
array of numbers

Multiple values may be separated by commas.

account_id__not_in
date-time

Only return segment uploads whose completion date exactly matches this timestamp.

date-time

Only return segment uploads whose completion date is after this timestamp.

date-time

Only return segment uploads whose completion date is at or after this timestamp.

boolean

When true, only return segment uploads with no completion date. When false, exclude them.

date-time

Only return segment uploads whose completion date is before this timestamp.

date-time

Only return segment uploads whose completion date is at or before this timestamp.

date-time | null
enum

Only return segment uploads whose completion date falls in the selected relative date range.

  • today - From last midnight to next midnight
  • yesterday - The last complete calendar day
  • last_24_hours - The last 24 hours (as opposed to today, which is from midnight to midnight)
  • this_week - From midnight the previous Sunday until midnight the coming Sunday
  • last_week - The last complete calendar week
  • this_year - From the January 1 to December 31 this year
  • last_year - The last complete calendar year
  • this_month - From the first day to the last day of the current month
  • last_month - The last complete calendar month
  • this_quarter - From the first day to the last day of the current quarter
  • last_quarter - The last complete calendar quarter
  • last_7_days - From midnight 7 days ago to the present
  • last_7_complete_days - From midnight 7 days ago to last midnight
  • last_14_days - From midnight 14 days ago to the present
  • last_14_complete_days - From midnight 14 days ago to last midnight
  • last_30_days - From midnight 30 days ago to the present
  • last_30_complete_days - From midnight 30 days ago to last midnight
  • last_90_days - From midnight 90 days ago to the present
  • last_90_complete_days - From midnight 90 days ago to last midnight
  • last_365_days - From midnight 365 days ago to the present
  • last_365_complete_days - From midnight 365 days ago to last midnight
  • past - Any date in the past. Useful for Buzz queries against end_date and similar fields
  • future - Any date in the future. Useful for Buzz queries against end_date and similar fields
  • until_past_24_hours - From the very first date in the past and up until past 24 hours
string

Only return segment uploads whose continent exactly matches this value.

continent__in
array of strings

Only return segment uploads whose continent matches one of these values. Multiple values may be separated by commas.

continent__in
boolean

When true, only return segment uploads with an empty or missing continent. When false, exclude them.

string

Exclude segment uploads whose continent exactly matches this value.

continent__not_in
array of strings

Exclude segment uploads whose continent matches one of these values. Multiple values may be separated by commas.

continent__not_in
date-time
date-time
date-time
boolean
date-time
date-time
date-time | null
enum

The date and time the object was first created

  • today - From last midnight to next midnight
  • yesterday - The last complete calendar day
  • last_24_hours - The last 24 hours (as opposed to today, which is from midnight to midnight)
  • this_week - From midnight the previous Sunday until midnight the coming Sunday
  • last_week - The last complete calendar week
  • this_year - From the January 1 to December 31 this year
  • last_year - The last complete calendar year
  • this_month - From the first day to the last day of the current month
  • last_month - The last complete calendar month
  • this_quarter - From the first day to the last day of the current quarter
  • last_quarter - The last complete calendar quarter
  • last_7_days - From midnight 7 days ago to the present
  • last_7_complete_days - From midnight 7 days ago to last midnight
  • last_14_days - From midnight 14 days ago to the present
  • last_14_complete_days - From midnight 14 days ago to last midnight
  • last_30_days - From midnight 30 days ago to the present
  • last_30_complete_days - From midnight 30 days ago to last midnight
  • last_90_days - From midnight 90 days ago to the present
  • last_90_complete_days - From midnight 90 days ago to last midnight
  • last_365_days - From midnight 365 days ago to the present
  • last_365_complete_days - From midnight 365 days ago to last midnight
  • past - Any date in the past. Useful for Buzz queries against end_date and similar fields
  • future - Any date in the future. Useful for Buzz queries against end_date and similar fields
  • until_past_24_hours - From the very first date in the past and up until past 24 hours
number
number
number
id__in
array of numbers

Multiple values may be separated by commas.

id__in
number
number
number
id__not_in
array of numbers

Multiple values may be separated by commas.

id__not_in
boolean

Only return segment uploads whose PII flag matches this value.

string

Which field to use when ordering the results.

string

Only return segment uploads whose partner handle exactly matches this value.

partner_handle__in
array of strings

Only return segment uploads whose partner handle matches one of these values. Multiple values may be separated by commas.

partner_handle__in
boolean

When true, only return segment uploads with an empty or missing partner handle. When false, exclude them.

string

Exclude segment uploads whose partner handle exactly matches this value.

partner_handle__not_in
array of strings

Exclude segment uploads whose partner handle matches one of these values. Multiple values may be separated by commas.

partner_handle__not_in
string
enum

Only return segment uploads whose status exactly matches this value.

  • NOT_UPLOADED - Not Uploaded
  • PENDING - Pending
  • COMPLETE - Complete
  • ERROR - Error
  • IN_PROGRESS - In Progress
  • PII_NOT_INGESTED - Pii Not Ingested
Allowed:
date-time
date-time
date-time
boolean
date-time
date-time
date-time | null
enum

The date and time the object was last updated

  • today - From last midnight to next midnight
  • yesterday - The last complete calendar day
  • last_24_hours - The last 24 hours (as opposed to today, which is from midnight to midnight)
  • this_week - From midnight the previous Sunday until midnight the coming Sunday
  • last_week - The last complete calendar week
  • this_year - From the January 1 to December 31 this year
  • last_year - The last complete calendar year
  • this_month - From the first day to the last day of the current month
  • last_month - The last complete calendar month
  • this_quarter - From the first day to the last day of the current quarter
  • last_quarter - The last complete calendar quarter
  • last_7_days - From midnight 7 days ago to the present
  • last_7_complete_days - From midnight 7 days ago to last midnight
  • last_14_days - From midnight 14 days ago to the present
  • last_14_complete_days - From midnight 14 days ago to last midnight
  • last_30_days - From midnight 30 days ago to the present
  • last_30_complete_days - From midnight 30 days ago to last midnight
  • last_90_days - From midnight 90 days ago to the present
  • last_90_complete_days - From midnight 90 days ago to last midnight
  • last_365_days - From midnight 365 days ago to the present
  • last_365_complete_days - From midnight 365 days ago to last midnight
  • past - Any date in the past. Useful for Buzz queries against end_date and similar fields
  • future - Any date in the future. Useful for Buzz queries against end_date and similar fields
  • until_past_24_hours - From the very first date in the past and up until past 24 hours
Responses

400

Invalid filter or query parameters.

401

Authentication credentials were not provided.

403

Permission denied.

Updated 7 days ago

Did this page help you?
Language
Credentials
:
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 7 days ago

Did this page help you?