API INTERNAL DOCUMENTATION

Frequently Asked Questions

I am not getting a JSON response. What should I do?

There are several reasons for not getting a JSON response. The first thing to do is to check the response status code. If it is anything other than 200 (OK), some errors might have occurred. The body of the response will usually contain a text error message.

The following lists a few possible scenarios:

  • If you get a 200 (OK) response but an empty body, then no results were found based on your query. This could be due to a combination of parameters that returned no results. Try removing some parameters, such as filters. Take note that data is usually only available at 8 a.m. (Singapore Time) the next day.
  • If you get a 403 (Unauthorized) response, it usually means that you have requested for data that you do not have permission to access. Check your access level, and try a different combination of parameters. Note that the free tier only allows you to query 24 hours of data at a time.
  • Check your parameters to make sure you include all mandatory parameters, and that the format and spelling of all parameters are correct.

Where can I find the geohierarchy of Singapore? 

In Singapore, there are three levels of geohierarchy, they are Regions, Planning Areas, and Subzones. Keyhole Markup Language (KML) files (.kml) and Shape files (.shp ) for the geohierarchy boundaries can be downloaded at the following locations: 

Can the codes and names of places available in the KML or Shape files be used with APIs? 

Yes, the files are available for download as mentioned in the preceding question. After the files have been downloaded, open the files using any geographic information system application to view the attributes for the regions within the shape. The code, names, and boundaries used by the APIs are defined by the Urban Redevelopment Authority (URA). URA is Singapore’s land use planning and conservation authority. 

Do you apply a privacy filter? 

Yes. To comply with the privacy policies of our data sources, any aggregations on metrics which return the following values will be reported as indicated:

  • Between 1 and 39 will be reported as -1.
  • 0 will be reported as 0.
  • 40 and above will be reported as the actual value.

How is extrapolation applied to the aggregated metrics? 

Extrapolation is applied to aggregated metrics such as unique_agents and metrics that includes counts with “total_”. Any aggregations will be extrapolated from the telecommunications observations to the population level by applying a computed extrapolation factor that is based on market share, mobile device ownership, and other factors. 

How do I perform query over multiple days? 

Use the range type in the dates object and specify your beginDate and endDate range. For an additional aggregation over the multiple days, use the multiDayAggregation object.