Input and output to Socrata services consists of different types of data elements. Types include primitive types such as strings and integers as well as complex types that are composed of other types.
This section describes Socrata API types in detail.
User
provides data from user profiles. Profile information provided includes:Fields:
city
stringThe city in which the user resides, if applicable
company
stringThe company the user is a part of, if applicable.
country
stringThe country in which the user resides, in ISO 3166 format
createdAt
datetimeThe date on which this user's account was created
createdOnDomainId
integerThe domain where the user was created on
description
stringA description of the user
displayName
stringThe display name the user opts to show.
email
stringThe user's email address (only available for the currently authenticated user)
firstName
stringThe user's first name, if provided
id
stringA unique identifier for this User
interests
stringA description of the user's interests
lastLogin
datetimeThe date the user last logged in
lastName
stringThe user's last name, if provided
login
stringThe user's login
numberOfFollowers
integerThe number of followers the user has
numberOfFriends
integerThe number of friends the user has
publicTables
integerThe number of public datasets this user has created
publicViews
integerThe number of public views user has created
screenName
stringScreen name does not have to be unique. User can opt to show their full name or screen name depending on their preferences in privacy control.
state
stringThe state in which the user resides, if applicable
tags
string[]An array of user-specified tags for this user
title
stringThe user's title
userLinks
UserLink[]External links the user has added to their profile
View
. A View
includes all of the metadata about a table or view, including descriptive values such as name, description, and tags, as well as structural data like the ViewColumns
it contains and any SortBy
s or ViewFilter
s that have been specified.
Fields:
columns
ViewColumn[]List of columns that the authenticated user has permissions to
description
stringThe user-defined description for this view
displayType
stringThe type of display used by this view e.g. map, table, line chart etc.
downloadCount
integerThe number of times this view has been downloaded
flags
string[]An array of flags which will include any of the following that apply to this View:grants
Grant[]The visible permissions on this view. If you are the owner of this view, you will see all the permissions you have granted on this view. If you are not the owner, you will see only the public permissions that have been granted on this view.
id
stringA unique ID for this view
name
stringThe user-specified name for this view
owner
UserThe User
who created this this view
rights
string[]The effective rights the authenticated user has on this view
rowsUpdatedAt
datetimeThe last time data in this view was updated, including changes to the underlying table
rowsUpdatedBy
stringThe ID of the user who last edited this table
searchString
stringThe full text search string that defines this filtered view
tableId
integerThe ID of the parent dataset for this view
tags
string[]An array of owner-specified tags for this view
userTags
UserTag[]An array of user-specified tags for this view
viewCount
integerThe number of times this view has been opened
viewType
stringThe type of the underlying dataset. This can currently be "tabular" for a traditional dataset , "blobby" for a binary blob, or "href" for linked datasets