Spotzi Webservice

2022-04-08

Webservice API, Query, Select, Insert, Update, Delete

The Spotzi Webservice allows users to automate key aspects of their workflow by connecting datasets stored in their Spotzi Targeting account to other services. Spotzi's demographics data, consumer insights, and other datasets can then collaborate with the tools and services most relevant to your brand or business. Similarly, Spotzi's Webservice can be used to streamline updates to your own datasets within the Spotzi platform.

Introduction
Base URL
Parameters
Response formats
Examples

Introduction

There are four types of requests that can be fulfilled by Spotzi's Webservice.

A walkthroughs of each request can be found in the corresponding Help Center articles. Spotzi's Webservice is available to all Spotzi Targeting users via the Spotzi Webservice App; keep reading to learn more about this webservice and its uses.

Base URL

A typical webservice request is as follows:

https://webservice.spotzi.com/visualization/wo/sql?parameters

Parameters

The parameters appended to the Base URL of Spotzi's Webservice consist of the parameter name followed by the parameter value. These parameters are split by the & sign. A typical parameter generally follows the form below:

parameter_name=parameter_value&

Please see this table for an overview of the required parameters:

q = The request query that has to be executed


EXAMPLE: SELECT * FROM tablename LIMIT 1

userName = A valid username
EXAMPLE: demouser

userKey = A valid apikey
EXAMPLE: 1973b5f4b6d0eda968092eecb8362d589ac9a496

format = The desired response format (see Response formats)
EXAMPLE: application/json

Response formats

The following response formats are available within the Spotzi Webservice.

Name	Type	HTTP content type
CSV	File/text	text/csv
JSON	Text	application/json
XML	Text	text/xml

Examples

A typical webservice request — with all of its parameters — can be seen below:

https://webservice.spotzi.com/visualization/wo/sql?q=SELECT description, name FROM dataset_name&userName=demouser&userKey=xxx&format=application/json

You can find examples of each possible request type in the corresponding articles:

Please note that users require a Spotzi Targeting account in order to use the Spotzi Webservice.