Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

The Data API allows users to run a variety of reports based on the UberAds geo-summary logs.

Job Status List

You may view existing jobs and their status on this listing screen.  If there are no jobs listed in this table, click the “Create Job” on the left panel to get started.

Job ID: Job ID is a numerical designation to keep track of your requested Data API jobs. Click this number to see more details about the requested job.

Status: There are four possible statuses for a submitted job: SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.

  • Submitted: The job has been submitted but has not yet begun processing.
  • In Progress: The job is processing. You will be alerted via email when the job is complete.
  • Completed: The job is complete and the report(s) will be available via email or via download in the UI.
  • Failed: The job has failed. If you see this status, please contact your UberMedia account manager in order to assess the problem.

If a job has completed, the report type will be visible in the appropriate column: Visitor, Device-based, or Path-to-Purchase. You may download the report by clicking on the report type.

Create a new Job

You may create a new job by clicking on “Create Job” in the left panel. This will send you to the Create New Job screen.

Report Details

In this area you will set all report details.

  • Name: This is a required field
  • Report Type: There are three report types:  Visitor Report, Device-based Reports, Path-to-Purchase Reports. At least one report selection is required. You may also select one of each report type per job, but running multiple report types is not required.
    • Visitor Reports:
      • Zero Point Report: Provides information on devices seen in a polygon during a set time period, as well as a timestamp of the visit.
      • Visitor Count Report: Provides a total count of visitors in a polygon for a set time period.
    • Device-based Reports:
      • CEL/CDL Location Report: Provides the location that devices spend the majority of their time for each device ID observed in a polygon. This could be a residence or, for overnight workers, a business.  These high confidence locations are called CEL (Common Evening Locations)/CDL (Common Daytime Locations) and are NOT available for all visitors. Thus, the amount of device IDs listed is likely to be smaller than in a visit count report. Also, the existence of a common daytime location does not imply that a common nighttime location is available and vice-versa. The determination of CEL/CDL uses multiple observation points across months of time, IP screening and other proprietary methodology.
      • Generator Report: Provides the likely origin point for a visitor (evening or daytime location), using a different methodology than CEL/CDL. This is done by evaluating the past 7 days of observation points for a device and is much lower confidence than CEL/CDL but generally has a larger overlap with visitor count.
    • Path-to-purchase Reports:
      • Pathing X Report: Provides information on where a device was seen prior to being inside a polygon. Please note that “Time before appearance” is in seconds. Actual visit will also be present in this report, but have a “Time before appearance” value of 0.
      • Pre-Post Report: Provides ALL the points a device was seen in the X time before an appearance in the polygon AND the X time after the appearance in the polygon.
  • Polygon Format: each job requires a valid GeoJSON or KML string. After selecting the correct format, paste the GeoJSON or KML string in the text box below.
  • Start Date and Time: This is a required field. Please note that it must be in UTC.
  • End Date and Time: This is a required field. Please note that it must be in UTC.
  • Seconds Before: An integer value that specifies the number of seconds before selected date and time. Required for Path-to-Purchase reports.  
  • Seconds After: An integer value that specifies the number of seconds before selected date and time. Required for Path-to-Purchase reports.

When the form is completed, click “Run Report” to submit the job. You will be redirected to the Job Status page, and emailed with results when the report(s) are ready.

 

  • No labels