What are these data tools?

Our data tools can help anyone view and download all sorts of local open data and apply some calculated analysis too. It’s ideal if you want to take a deeper look at the data behind LG Inform Plus and use it in your own way.

What do I need?

Before you can use the tools, you’ll need to sign in to your account (local authority staff) or request a security key (developers).

Need more help?

Search our knowledge base to find the help you need.

To see data you must:

, ,
, ,

Download

Download and save this data

Permanent url and request

Create a permanent url to the data source using a public private key

Code samples

Use these samples in your web applications. Click here for help using the code

jQuery code snippet

sample PHP code to sign this call

sample PHP code to sign this call and show in Highcharts

/areaTypes

Returns area types, including detailed area types such as MBC and London borough.

Example call

Parameters

area
Limit to the area types within a particular area.
Example call
https://webservices.esd.org.uk/areaTypes?area=E09000006&ApplicationKey=ExamplePPK&Signature=agv/ZK0ZU1LJp4oGlrKZ9yDLhNc=



/areaTypes/current

Current user's area type. Requires a call using OAuth to retrieve data.




/areaTypes/filter-data

Area types which have data for a particular metric type and time period.

Parameters

metricType
Show which area levels have data for a particular metric type.
Example call
http://webservices.esd.org.uk/areaTypes/filter-data?metricType=3214&ApplicationKey=ExamplePPK&Signature=xs9ULS0M6FeC69qGpXMuCN/HZ3E=
period
Show which area levels have data for a particular time period.
Example call
https://webservices.esd.org.uk/areaTypes/filter-data?period=cal_2005&ApplicationKey=ExamplePPK&Signature=nttBsPWQMIv7IJoDq7/Xyoh85RM=



/areaTypes/{identifier}

Details about a particular area type.

Example call




/areas

Geographical areas used by LG Inform. Due to the large number of areas an empty call returns no results. Results are limited to first 500 - subsequent results can be found using the "pageNumber" attribute.

Example call

Parameters

applicableToMetricType
Filter areas by comparison group and metric type's applicable area types
Example call
https://webservices.esd.org.uk/areas?area=AllLaInRegion_London&applicableToMetricType=123&ApplicationKey=ExamplePPK&Signature=jtdgOw3IBtZSc2iJZk+yN+WNDI8=
area
Filter by area type and parent area
Example call
https://webservices.esd.org.uk/areas?area=E92000001:County&ApplicationKey=ExamplePPK&Signature=wKl0vjaKo4B8koZ/UfIIQNDUmvA=
areaType
All areas of a particular area type
Example call
https://webservices.esd.org.uk/areas?areaType=County&ApplicationKey=ExamplePPK&Signature=5YIvjY0jp28sjmzKqePlLgNRCt0=
pageNumber
If retrieving more than 20,000 areas or 500 shapes this can be used to return subsequent pages.
Example call
https://webservices.esd.org.uk/areas?areaType=LLSOA&pageNumber=3&ApplicationKey=ExamplePPK&Signature=3nGMbflfdPZ1DyaaTa50q62vluE=
pageSize
Number if items to be returned in each call up to a limit of 500, which is the default.
Example call
https://webservices.esd.org.uk/areas?areaType=LondonBorough&pageSize=10&ApplicationKey=ExamplePPK&Signature=GkXTIJ1OzC0kolEpj3bpRB5/xHA=
searchText
The search text can be either a postcode, a postcode district (the first half of the postcode), or a text string. Defaults to local authorities whether the areaType parameter is not specified.
Example call
https://webservices.esd.org.uk/areas?searchText=sw11&areaType=LocalAuthority&ApplicationKey=ExamplePPK&Signature=w31xlvp2jAtNPYne6KTrg4iLp28=



/areas/{identifier}

The identifier is a GSS code, or comparison group identifier, used to find details about a particular geographical area

Example call




/areas/{identifier}/bounds

Co-ordinates for the minimum and maxim longitude and latitudes for a particular area or group of areas.

Example call




/areas/{identifier}/shape

The identifier is either a GSS code, or comparison group identifier, and is used to retrieve KML data for the corresponding geographical area(s)

Example call

Parameters

changedSince
Only return areas whose information has changed since a specified date
Example call
https://webservices.esd.org.uk/areas/E09000010/shape?changedSince=2012-06-15&ApplicationKey=ExamplePPK&Signature=2MWOlLkjCQSEbz+4e0Y2rJF9KQo=
pageNumber
Larger calls can be split into different pages. All calls are automatically limited to 500 areas. Use this attribute to find subsequent pages.
Example call
https://webservices.esd.org.uk/areas/AllBoroughInRegion_London/shape?pageNumber=2&pageSize=1&ApplicationKey=ExamplePPK&Signature=t28SXAxGdMh9BWaP5XVvU4OOzD0=
pageSize
Limit the number of areas returned in each KML file.
Example call
https://webservices.esd.org.uk/areas/AllBoroughInRegion_London/shape?pageNumber=2&pageSize=1&ApplicationKey=ExamplePPK&Signature=t28SXAxGdMh9BWaP5XVvU4OOzD0=



/bounds

Co-ordinates for the minimum and maxim longitude and latitudes for a particular area or group of areas.

Parameters

area
Returns the minimum and maximum longitudes for an area or group of areas.
Example call
https://webservices.esd.org.uk/bounds?area=E09000031&ApplicationKey=ExamplePPK&Signature=W5TvatRr/255Nt6AUWAavpgaXVw=



/calculationMethods/verbose

Show all properties of available calculation methods.

Example call




/calculationMethods/{identifier}

Show properties of a specified calculation methods.

Example call




/calculationPeriodTypeRules

Show match type for different combinations of numerator and denominator period type.

Example call

Parameters

denominatorPeriodType
Show match type for calculations with a specific denominator.
Example call
https://webservices.esd.org.uk/calculationPeriodTypeRules?denominatorPeriodType=FinancialYear&ApplicationKey=ExamplePPK&Signature=blnZAOYfGKN2Dd+2R1XjUjg574Y=
numeratorPeriodType
Show match type for calculations with a specific numerator.
Example call
https://webservices.esd.org.uk/calculationPeriodTypeRules?numeratorPeriodType=FinancialYear&ApplicationKey=ExamplePPK&Signature=vExbi+NQ8j2IyGdoYJrrDObUjkI=



/clientApplications/{Identifier}

Show details of specific client application.

Example call




/comparisonGroupTypes/verbose

Show full details of comparison group types available

Example call




/comparisonGroupTypes/{identifier}

Show details of a specified comparison group.

Example call




/comparisonGroups

Comparison groups are area groupings of different types, such as all district local authorities, or all fire organisations in England. Without parameters, all groups, excluding custom groups, are returned.

Example call

Parameters

mainOnly
Only the main comparison groups, so includes groupings by authority type, but excludes things like groupings by near neighbours.
Example call
https://webservices.esd.org.uk/comparisonGroups?mainOnly=true&ApplicationKey=ExamplePPK&Signature=F/a+j36cOnIBzEB2SLjueS78ae4=
memberArea
Groups of which the area is a member, but not necessarily an owner. If area 1 is a near neighbour of area 2, area 1 would be a member of the near neighbour group (along with the other near neighbours) and area 2 would be the owner of the group
Example call
https://webservices.esd.org.uk/comparisonGroups?memberArea=E09000010&ApplicationKey=ExamplePPK&Signature=wb/SCgOhI3LWRI/rHD7Z6xXGJAk=
ownerArea
Group which the area owns, but is not necessairly a member. An area is generally the owner of a group if the group is a main group, such as all local authorities, or is the area to which a group relates, such as near neighbours of an area.
Example call
https://webservices.esd.org.uk/comparisonGroups?ownerArea=E09000010&ApplicationKey=ExamplePPK&Signature=917TTVYq+6Gk5ov9Ln0ItprZy5c=
type
Comparison groups of a specified comparison group type for a specified area. For example, which Experian Mosaic near neighbours a particular area has.
Example call
https://webservices.esd.org.uk/comparisonGroups?type=AllLaInRegion&ApplicationKey=ExamplePPK&Signature=iGhJCZ4ICVSWnE00NH5+av4T8/M=



/comparisonGroups/current

Shows comparison groups visible to the current user, including all main groups, non-main groups owned by user's area (e.g. Near neighbours) and custom comparison groups.

Parameters

user
Shows the main comparison group and any custom groups for a particular user, selected by user identifier.



/comparisonGroups/custom

A user can create groups of areas that they are interested in. These are called custom comparison groups. The call with no parameters returns the groups for the signed in user.

Parameters

user
A list of only the custom comparison groups for a selected user.



/comparisonGroups/custom/create

Create a custom comparison group for a user.

Parameters

areas
A list of the areas, identified by GSS code, to be included within the custom comparison group
label
A label for the custom comparison group.



/comparisonGroups/custom/{identifier}/delete

Delete a users custom comparison group.




/comparisonGroups/custom/{identifier}/update

Update a specified custom comparison group for a user.

Parameters

areas
Update the areas associated with a comparison group. All previous areas will be removed.
label
Update the label associated with a custom comparison group.



/comparisonGroups/{identifier}

Returns the details for a particular comparison group.

Example call




/comparisonGroups/{identifier}/bounds

Co-ordinates for the minimum and maxim longitude and latitudes for a particular comparison group.

Example call

Parameters

area
Returns the minimum and maximum longitudes for a comparison group.
Example call
https://webservices.esd.org.uk/comparisonGroups/AllLaInRegion_London/bounds?ApplicationKey=ExamplePPK&Signature=zMSpteBzPihoAHYq00LOI7HDNdE=



/comparisonGroups/{identifier}/shape

Returns KML shapes of all areas in a comparison group

Example call

Parameters

changedSince
Only include shapes whose data has been updated since the specified date
Example call
https://webservices.esd.org.uk/comparisonGroups/AllLAInRegion_London/shape?changedSince=2012-06-15&ApplicationKey=ExamplePPK&Signature=PxJDMurALl5AETUtXQdv/o+O8vk=
pageNumber
Larger calls can be split into different pages. All calls are automatically limited to 500 areas. Use this attribute to find subsequent pages.
Example call
https://webservices.esd.org.uk/comparisonGroups/AllBoroughInRegion_London/shape?pageNumber=2&pageSize=1&ApplicationKey=ExamplePPK&Signature=qfsgyYw0CA9jVBzML2OgQNd5P84=
pageSize
Limit the number of areas returned in each KML file.
Example call
https://webservices.esd.org.uk/comparisonGroups/AllBoroughInRegion_London/shape?pageNumber=2&pageSize=1&ApplicationKey=ExamplePPK&Signature=qfsgyYw0CA9jVBzML2OgQNd5P84=



/data

Returns table or values to populate a user specified table component. At minimum, 'area', 'metricType' and 'period' parameters are required.

Note that when the denominator metric type uses a different period type from the numerator. The first denominator period that has a "end date" less than the chosen numerator period is used with the denominator metric type.

Parameters

area
The area or comparison group that the data values are for.
Example call
https://webservices.esd.org.uk/data?area=E92000001&metricType=1&period=latest&ApplicationKey=ExamplePPK&Signature=wlOfNxNbg4/EA3KE8dC0NgGvUn4=
columnGrouping
Specify how the results will be grouped when viewed in a tabular format.
Example call
https://webservices.esd.org.uk/data?metricType=1&area=E92000001&period=latest&outputType=table&columnGrouping=metricType&columnGrouping=period&ApplicationKey=ExamplePPK&Signature=RAROU2AVKd6v4zdpsK4krMthPKk=
headerCellType
Whether the header cells should be labels or identifiers.
Example call
https://webservices.esd.org.uk/data?metricType=1&area=E92000001&period=latest&headerCellType=label&ApplicationKey=ExamplePPK&Signature=9UvGm3zdCT/+xbkNKfbymEDIXBc=
includeMissing
If this is set to true, areas which do not have values will be included in the results.
Example call
https://webservices.esd.org.uk/data?metricType=3&area=AllLAInRegion_London&period=latest&includeMissing=true&ApplicationKey=ExamplePPK&Signature=y3IwQiYg3BEyi/A5Br8naKdvsE0=
metricType
The metric type the data value is for.
Example call
https://webservices.esd.org.uk/data?metricType=1&area=E92000001&period=latest&ApplicationKey=ExamplePPK&Signature=6KLhNftJrETFU8Tbtnkmyb1bWQw=
outputType
Format for which the data will be used. For example table or pie.
Example call
https://webservices.esd.org.uk/data?metricType=1&area=E92000001&period=latest&outputType=table&ApplicationKey=ExamplePPK&Signature=ROp9e0AWtBV7WZ5BtdImXdKQfYs=
period
The time period that is to be returned. To just retrieve data for the latest available period, use "latest". For the most recent two time periods, use "latest:2", and so on. Otherwise one or more time period identifiers can be used.
Example call
https://webservices.esd.org.uk/data?period=latest:2&area=E92000001&metricType=1&ApplicationKey=ExamplePPK&Signature=/yj/CL4JjRPoMTfdp/PgHTeLU/o=
rowGrouping
Specify how the results will be grouped when viewed in a tabular format.
Example call
https://webservices.esd.org.uk/data?metricType=1&area=E92000001&period=latest&outputType=table&rowGrouping=metricType&ApplicationKey=ExamplePPK&Signature=pUg6EhRwwBlRN/pee6bgdupn5Ts=
summary
Use summaryType to define the type of summary and what will be summarised. Example summary types are sum, min and max.
Example call
https://webservices.esd.org.uk/data?metricType=1&area=AllLAInCountry_England&period=latest&value.number=1&summary.summaryType=max&summary.summaryFor=area&ApplicationKey=ExamplePPK&Signature=OdxdDeSQnw5bSjyknEJsRgv5fW8=
valueType
The type of value that is returned for each query is defined by the valueType parameter, examples are raw, rank and band.
Example call
https://webservices.esd.org.uk/data?metricType=1&area=E92000001&period=latest&value.valueType=direction&ApplicationKey=ExamplePPK&Signature=DlLT1cr7sslfjWyV/7MHDeddEPA=



/data/regression

Returns table or values to populate a user specified table component and includes a regression x1, y1, x2, y2 coordinate for the regression line between each pair of columns. As with /data, at minimum 'area', 'metricType' and 'period' are required. The regression values appear at the end of the data results.

Parameters

Same as /data method
Use the same parameters that are available for the /data method.
Example call
https://webservices.esd.org.uk/data/regression?metricType=1%2C11&area=AllLAInRegion_London&period=latest:2&value1.valueType=raw&outputType=table&columnGrouping=metricType&columnGrouping=period&rowGrouping=area&includeMissing=true&headerCellType=label&ApplicationKey=ExamplePPK&Signature=6KMVIKBYKDLUTjx1V3w4Nqgc2vc=



/datasetCollections

The source from which the data used by any related datasets was obtained.

Example call




/datasetCollections/verbose

Full details of all sources used by datasets.

Example call




/datasetCollections/{identifier}

Full details of a particular source, using its identifier.

Example call




/datasets

Returns a list of datasets. Only basic details are provided including identifier, label and some others.

Example call




/datasets/{identifier}

Details about a particular dataset, using its identifier.

Example call




/derivation

Shows the source and calculation steps (if applicable) for a specified metric value.

Parameters

area
The area or comparison group that the derived data values are for.
Example call
https://webservices.esd.org.uk/derivation?area=E92000001&metricType=1&period=latest&ApplicationKey=ExamplePPK&Signature=3U1u0H+q3lNADgVzaOJHcOvBIwE=
metricType
The metric type ID the derived data values are for.
Example call
https://webservices.esd.org.uk/derivation?area=E92000001&metricType=1&period=latest&ApplicationKey=ExamplePPK&Signature=3U1u0H+q3lNADgVzaOJHcOvBIwE=
organisationID
Show derivation from perspective of a specific organisation.
Example call
https://webservices.esd.org.uk/derivation?metricType=4236&period=latest&outputType=both&area=E10000012&organisationID=Essex&ApplicationKey=ExamplePPK&Signature=axvaoKc7AXIkddV6PNIvqY+8iFU=
outputType
Specify values, metrictypes or both to determine the data included in the output.
Example call
https://webservices.esd.org.uk/derivation?metricType=2117&period=latest&outputType=both&area=E14000695&ApplicationKey=ExamplePPK&Signature=04322hMUIlBq6o1PqSBo8KXeryg=
period
The time period that is to be returned. To just retrieve data for the latest available period, use "latest". For the most recent two time periods, use "latest:2", and so on. Otherwise one or more time period identifiers can be used..
Example call
https://webservices.esd.org.uk/derivation?area=E92000001&metricType=1&period=latest&ApplicationKey=ExamplePPK&Signature=3U1u0H+q3lNADgVzaOJHcOvBIwE=
virtualMetricType.denominator
Specify denominator metric ID to use in virtual metric calculation.
Example call
https://webservices.esd.org.uk/derivation?area=E92000001&period=latest&virtualMetricType.denominator=176&virtualMetricType.multiple=10&virtualMetricType.numerator=1&virtualMetricType.label=Test VM&ApplicationKey=ExamplePPK&Signature=Y29/xeTBSDVHG5o09DYqcmKoVic=
virtualMetricType.label
Specify a label for your virtual metric.
Example call
https://webservices.esd.org.uk/derivation?area=E92000001&period=latest&virtualMetricType.denominator=176&virtualMetricType.multiple=10&virtualMetricType.numerator=1&virtualMetricType.label=Test VM&ApplicationKey=ExamplePPK&Signature=Y29/xeTBSDVHG5o09DYqcmKoVic=
virtualMetricType.multiple
Specify a multiple for your virtual metric calculation.
Example call
https://webservices.esd.org.uk/derivation?area=E92000001&period=latest&virtualMetricType.denominator=176&virtualMetricType.multiple=10&virtualMetricType.numerator=1&virtualMetricType.label=Test VM&ApplicationKey=ExamplePPK&Signature=Y29/xeTBSDVHG5o09DYqcmKoVic=
virtualMetricType.numerator
Specify numerator metric ID to use in virtual metric calculation.
Example call
https://webservices.esd.org.uk/derivation?area=E92000001&period=latest&virtualMetricType.denominator=176&virtualMetricType.multiple=10&virtualMetricType.numerator=1&virtualMetricType.label=Test VM&ApplicationKey=ExamplePPK&Signature=Y29/xeTBSDVHG5o09DYqcmKoVic=



/dimensionMembers

List of all dimension members. Dimension members are synonymous with circumstances, and dimensions with cirumstance collections, as listed on the standards site. Dimension members may apply to multiple metric types, and each metric type can be related to multiple dimension members. For example the metric type for males aged 0-17 has the dimension members of both male in the gender dimension and 0-17 in the social aervices age bands dimension.

Example call




/dimensionMembers/verbose

Full details for all dimension members.

Example call




/dimensionMembers/{identifier}

Full details for a single dimension member, selected via the identifier.

Example call




/dimensions

Groups of related dimension members. Dimensions are synonymous with circumstance collections, as listed on the standards site.

Example call




/dimensions/verbose

List of all dimensions, giving their full details.

Example call




/dimensions/{identifier}

Full details of a single dimension, selected by its identifier.

Example call




/editor/config

Default configuration for the text token editor.

Example call

Parameters

area
Default text token editor settings for a particular area.
Example call
https://webservices.esd.org.uk/editor/config?area=E09000031&ApplicationKey=ExamplePPK&Signature=zbmWMwn2QkUzAvx8c0s97uFjsow=
areaTypeMax
Specify highest level area type to show in hierarchy.
Example call
https://webservices.esd.org.uk/editor/config?area=E10000012&areaTypeMax=Region&ApplicationKey=ExamplePPK&Signature=1qWto2DgwSp3JEvDtWrk1R+htxM=
authorityArea
Set the authority area in the default text token editor settings.
Example call
https://webservices.esd.org.uk/editor/config?authorityArea=E09000031&ApplicationKey=ExamplePPK&Signature=ukhrSXubAhv+7Xl810ipNYg409o=
childArea
Set the child area in the default text token editor settings.
Example call
https://webservices.esd.org.uk/editor/config?childArea=E05000590&ApplicationKey=ExamplePPK&Signature=pq2Bn21sq1Ts6igtDjLnw2Mst0w=
comparisonGroup
Specify comparison group.
Example call
https://webservices.esd.org.uk/editor/config?area=E10000012&comparisonGroup=AllCountiesInCountry_England&ApplicationKey=ExamplePPK&Signature=6iGs/GOF9gdJukM0czQ3OmlgCfg=
includeChildArea
Toggle whether to include child areas in hierarchy.
Example call
https://webservices.esd.org.uk/editor/config?area=E10000012&includeChildArea=0&ApplicationKey=ExamplePPK&Signature=7z4PCkuuGiM3ZfXbqS+yBK92CZI=
latestPeriod
Set default period identifier.
Example call
https://webservices.esd.org.uk/editor/config?area=E10000012&latestPeriod=2015&ApplicationKey=ExamplePPK&Signature=5fziiYy963VcWA4eOoZmwa7gqr4=
metricDimension
Set default metric dimension.
Example call
https://webservices.esd.org.uk/editor/config?area=E10000012&metricDimension=[545][545_Count][Gender][Agebandsocialservices_0_17]&ApplicationKey=ExamplePPK&Signature=rZVOFV637AS1RRoejc7ZM/ot0MU=
metricType
Set default metric type.
Example call
https://webservices.esd.org.uk/editor/config?area=E10000012&metricType=1&ApplicationKey=ExamplePPK&Signature=AdElq8Viz9HYa8Q5PBrenwWoIXQ=



/editor/fields

List of fields and their default labels.

Example call

Parameters

area
Default field labels in the text token editor for a particular area.
Example call
https://webservices.esd.org.uk/editor/fields?area=E09000031&ApplicationKey=ExamplePPK&Signature=Ry4fj0r+hBJWDUE7C4PHEXJBq8A=
areaTypeMax
Specify highest level area type to show in hierarchy.
Example call
https://webservices.esd.org.uk/editor/fields?area=E10000012&areaTypeMax=Region&ApplicationKey=ExamplePPK&Signature=+NLstf7SSLWFP5uk3rN9Re7BQI4=
authorityArea
Default field labels in the text token editor for a particular authority area.
Example call
https://webservices.esd.org.uk/editor/fields?authorityArea=E09000031&ApplicationKey=ExamplePPK&Signature=NiHOkLGPLum82QZPk1P1PAFKlTk=
childArea
Default field labels in the text token editor for a particular child area.
Example call
https://webservices.esd.org.uk/editor/fields?childArea=E05000590&ApplicationKey=ExamplePPK&Signature=IbbMPkHFS1qQjLiY3qCng3i/kjU=
comparisonGroup
Specify comparison group.
Example call
https://webservices.esd.org.uk/editor/fields?area=E10000012&comparisonGroup=AllCountiesInCountry_England&ApplicationKey=ExamplePPK&Signature=45/mveDt2juye6I5tG3WWmvxDvY=
includeChildArea
Toggle whether to include child areas in hierarchy.
Example call
https://webservices.esd.org.uk/editor/fields?area=E10000012&includeChildArea=0&ApplicationKey=ExamplePPK&Signature=K9auiDoaqjOk4Nx8XpXQp18gX/k=
latestPeriod
Set default period identifier.
Example call
https://webservices.esd.org.uk/editor/fields?area=E10000012&latestPeriod=2015&ApplicationKey=ExamplePPK&Signature=Fuecw6x3fhz6mtMg/+L40U2gaQA=
metricDimension
Set default metric dimension.
Example call
https://webservices.esd.org.uk/editor/fields?area=E10000012&metricDimension=[545][545_Count][Gender][Agebandsocialservices_0_17]&ApplicationKey=ExamplePPK&Signature=G5aOlbB1PvpV15lJaCzE4iqSluI=
metricType
Set default metric type.
Example call
https://webservices.esd.org.uk/editor/fields?area=E10000012&metricType=1&ApplicationKey=ExamplePPK&Signature=iHWJk+lfv643ICEgRlHPnDpG25c=



/editor/functions

List of functions available, and associated metadata.

Example call

Parameters

area
Default function list and labels for a particular area.
Example call
https://webservices.esd.org.uk/editor/functions?area=E09000031&ApplicationKey=ExamplePPK&Signature=Y5mcmw0l+Mwev1gZgscinpCkddE=
areaTypeMax
Specify highest level area type to show in hierarchy.
Example call
https://webservices.esd.org.uk/editor/functions?area=E10000012&areaTypeMax=Region&ApplicationKey=ExamplePPK&Signature=OsgoDsC7L6njW051TBLdsLCFsxA=
authorityArea
Default function list and labels for a particular authority area.
Example call
https://webservices.esd.org.uk/editor/functions?authorityArea=E09000031&ApplicationKey=ExamplePPK&Signature=wcrU/hrLYotCtqQKmqCBgNiH3a0=
childArea
Default function list and labels for a particular child area.
Example call
https://webservices.esd.org.uk/editor/functions?childArea=E05000590&ApplicationKey=ExamplePPK&Signature=94qhSIlcMmN64e4yAChbqL44abU=
comparisonGroup
Specify comparison group.
Example call
https://webservices.esd.org.uk/editor/functions?area=E10000012&comparisonGroup=AllCountiesInCountry_England&ApplicationKey=ExamplePPK&Signature=UqqgWfigtmD0eocx9QyxDQTVwpA=
includeChildArea
Toggle whether to include child areas in hierarchy.
Example call
https://webservices.esd.org.uk/editor/functions?area=E10000012&includeChildArea=0&ApplicationKey=ExamplePPK&Signature=7xCDPDGF/oQ003rNOLi4hXpqfsQ=
latestPeriod
Set default period identifier.
Example call
https://webservices.esd.org.uk/editor/functions?area=E10000012&latestPeriod=2015&ApplicationKey=ExamplePPK&Signature=ZLAT7qgFcOyfTBw+woasHNjz5jY=
metricDimension
Set default metric dimension.
Example call
https://webservices.esd.org.uk/editor/functions?area=E10000012&metricDimension=[545][545_Count][Gender][Agebandsocialservices_0_17]&ApplicationKey=ExamplePPK&Signature=b8u3I5jdQdI3xJIJVxK/bNDU1hc=
metricType
Set default metric type.
Example call
https://webservices.esd.org.uk/editor/functions?area=E10000012&metricType=1&ApplicationKey=ExamplePPK&Signature=Ma6M2rssb4UcUk2KOBdQpTFgXxk=



/lists

Gives properties of lists and list subsets available through LG Inform Plus standards.

Example call




/lists/{listId}

Gives full properties of a single list and lists all its items.

Example call




/lists/{listId}/{identifier}

Gives full properties of a single list item.

Example call




/markerGroups

Show details and content of marker groups.

Parameters

categoryTypeId
Get marker groups for a specific category.
Example call
https://webservices.esd.org.uk/markerGroups?categoryTypeId=Amenity&ApplicationKey=ExamplePPK&Signature=EXHOxfd0Meq/8jyh70G34G7tbqU=
organisationID
Get marker groups owned by a specific organisation.
Example call
https://webservices.esd.org.uk/markerGroups?categoryTypeId=Amenity&organisationID=esdtoolkit&ApplicationKey=ExamplePPK&Signature=Nyr3ImtYSjzWXGA/1vW5DqLcXto=



/markers/shape

Provides KML map data for the marker points specified.

Parameters

area
Filter by area.
Example call
https://webservices.esd.org.uk/markers/shape?area=E10000012&ApplicationKey=ExamplePPK&Signature=jDV+YVWIh6b/KOS7oD/B0JfL+Qk=
categoryTypeId
Filter by a category type.
Example call
https://webservices.esd.org.uk/markers/shape?area=E10000012&categoryTypeId=Amenity&ApplicationKey=ExamplePPK&Signature=KV2YlzWm14Zc03rUzUkGkVMehRM=
dateRange
Filter by a given date range.
Example call
https://webservices.esd.org.uk/markers/shape?area=E10000012&dateRange=2015-01-01|2015-01-02&ApplicationKey=ExamplePPK&Signature=ZrkuUcV/zfNhJnjllEkJpxQi3sQ=
granularity
Change level of granularity in co-ordinates
Example call
https://webservices.esd.org.uk/markers/shape?area=E10000012&granularity=11111&ApplicationKey=ExamplePPK&Signature=0galTwm2USU+7OlfuPreWt4iVo4=
groupId
Filter by a marker group.
Example call
https://webservices.esd.org.uk/markers/shape?area=E10000012&groupId=Other&ApplicationKey=ExamplePPK&Signature=0dg55FoFtuwy+zYuXhUx2qnkZHQ=
includeAll
Include all markers, including ones not added centrally.
Example call
https://webservices.esd.org.uk/markers/shape?includeAll=false&area=E07000070&ApplicationKey=ExamplePPK&Signature=colli214IUtLT9vNFcfT2sjvH6M=
markerType
Filter by a specific marker type.
Example call
https://webservices.esd.org.uk/markers/shape?area=E10000012&markerType=local_Care_home_with_nursing&ApplicationKey=ExamplePPK&Signature=Ppu1qFhhRkhDzDdQtK/+EMLaPog=
organisationID
Filters results by a specified organisation.
Example call
https://webservices.esd.org.uk/markers/shape?organisationID=Lambeth&area=E09000022&ApplicationKey=ExamplePPK&Signature=Da3Im1IqyuJq6zZpNyZng7yIBxs=
styleIconNumber
Add number to style icon.
Example call
https://webservices.esd.org.uk/markers/shape?area=E10000012&styleIconPrefix=IconPrefix&styleIconNumber=123&ApplicationKey=ExamplePPK&Signature=KFg4u53wTMY2873y368+ePs+tTk=
styleIconPrefix
Add some prefix text to the icon URL.
Example call
https://webservices.esd.org.uk/markers/shape?area=E10000012&styleIconPrefix=IconPrefix&ApplicationKey=ExamplePPK&Signature=fCV53/0JY4zaTtqeO1d4A+31CBw=
styleIconScale
Change the default icon scale attribute from 0.3125 to a custom value.
Example call
https://webservices.esd.org.uk/markers/shape?area=E10000012&styleIconScale=0.5&ApplicationKey=ExamplePPK&Signature=577X4FCkZQTJjnlBjgOWk8oMiB4=
styleUrl
Allows insertion of KML code to produce a file which allows the default styleUrl attribute to be replaced by the styles in the given file.
Example call
https://webservices.esd.org.uk/markers/shape?area=E10000012&styleUrl=http://resources.esd.org.uk/styles/amenities-default.kml&ApplicationKey=ExamplePPK&Signature=y5sW0jElGxuxkTD4a/R2DOk9GYI=



/markers/shapeData

Provides data for the marker points specified in JSON format.

Parameters

area
Filter by a specified area.
Example call
https://webservices.esd.org.uk/markers/shapeData?area=E10000012&ApplicationKey=ExamplePPK&Signature=awQxHt9AE/ZiKORbmmXTt2UV6fY=
categoryTypeId
Filter markers by a category type.
Example call
https://webservices.esd.org.uk/markers/shapeData?area=E10000012&categoryTypeId=Amenity&ApplicationKey=ExamplePPK&Signature=7OkrOV6QR5s03t8JgXC50utKNtE=
dateRange
Filter markers by a specified date range.
Example call
https://webservices.esd.org.uk/markers/shapeData?area=E10000012&dateRange=2015-01-01|2015-01-02&ApplicationKey=ExamplePPK&Signature=kj+i5ITfgNWOSEaqPQYdxAXeSTk=
granularity
Change level of granularity in results.
Example call
https://webservices.esd.org.uk/markers/shapeData?area=E10000012&granularity=11111&ApplicationKey=ExamplePPK&Signature=CnTxzv0eUdI9mg/zsEXrgwibT1k=
groupId
Filter results by a marker group.
Example call
https://webservices.esd.org.uk/markers/shapeData?area=E10000012&groupId=Other&ApplicationKey=ExamplePPK&Signature=US8V+Zp+YhMT/jEGg6lEOvSnjXI=
includeAll
Include all markers, including ones not added centrally.
Example call
https://webservices.esd.org.uk/markers/shapeData?area=E07000070&includeAll=true&ApplicationKey=ExamplePPK&Signature=IoxtluLomOT6eMm8St6gXq7EOMI=
markerType
Filter results by a marker type.
Example call
https://webservices.esd.org.uk/markers/shapeData?area=E10000012&markerType=local_Care_home_with_nursing&ApplicationKey=ExamplePPK&Signature=wkQuh/+WR4d+C8fi1I6YP0/9Hjs=
organisationID
Filters results by a specified organisation.
Example call
https://webservices.esd.org.uk/markers/shapeData?organisationID=Lambeth&area=E09000022&ApplicationKey=ExamplePPK&Signature=A9+8azYnpPalkBZWqc/MvNg7mMs=



/markers/{identifier}

Provides data for a specific marker.

Example call




/measurementUnits

Returns a list of all measurement units which are used for defining the units used in measures.

Example call




/measurementUnits/verbose

Full details of all measurement units.

Example call




/measurementUnits/{identifier}

Returns all details of one measurement unit using the idenitifer of the specified measurement unit.

Example call




/measures

Returns all measures as they relate to a particular dataset. These are usually split into fairly simple measurement types, such as count, or percentage of population, but can be more complex.

Example call




/measures/verbose

Returns full details of all dataset measures.

Example call




/measures/{identifier}

Returns all details of one measure, as selected by the identifier.

Example call




/metadata

Show metadata for current version of database.

Example call




/metricDimensions

Metric dimension is a group of metric types having the same dataset, measure and all dimension members except for one dimension. Examples: "Employees - males, permanent by age (count)" "Employees - males, permanent by age (percentage)" ""Employees - by sex (percentage)". A dataset without dimensions has no metric dimensions.

Example call

Parameters

addNoneOption
As with metricTypeBreakdown, but with an additional "None" option.
Example call
https://webservices.esd.org.uk/metricDimensions?metricTypeBreakdown=1&addNoneOption=1&ApplicationKey=ExamplePPK&Signature=JyfS6ygt5PmsEkzbw2Obf3k1oIg=
metricTypeBreakdown
Returns the metric dimensions by which a specified metric type (or pseudo-metric type) breaks down.
Example call
https://webservices.esd.org.uk/metricDimensions?metricTypeBreakdown=1&ApplicationKey=ExamplePPK&Signature=Zh2Ojk1LOdTj8oF+ICsZXIhryc0=



/metricDimensions/search

Returns metric dimensions for a particular search term.

Example call

Parameters

q
The search term to filter the results by.
Example call
https://webservices.esd.org.uk/metricDimensions/search?q=population&ApplicationKey=ExamplePPK&Signature=Pq2NgpngEJryEHodioBxhw2rKyQ=
type
Filter results by type of item. In this case all results are "metricDimension", so adding a type will not further filter the results.
Example call
https://webservices.esd.org.uk/metricDimensions/search?q=population&type=metricDimension&ApplicationKey=ExamplePPK&Signature=4ebtw/MUD+hVOWidOulGEyEpwuU=



/metricDimensions/verbose

Full details of all metric dimensions.

Example call




/metricDimensions/{identifier}

Returns all details of one metric dimension using the identifier of the specified dimension.

Example call




/metricTypeCalculationMethods

Show details of calcuation methods used by a specific metric.

Parameters

metricType
Specify a metric type number.
Example call
https://webservices.esd.org.uk/metricTypeCalculationMethods?metricType=176&ApplicationKey=ExamplePPK&Signature=P4xQHXN2BiOA/NZTo/oZA0vyZk8=



/metricTypes

Returns a list of metric types. Only basic details are provided including identifier and label.

Example call

Parameters

aggregatable
Only include metric types whose area values can be aggregated together.
Example call
https://webservices.esd.org.uk/metricTypes?aggregatable=true&ApplicationKey=ExamplePPK&Signature=YgBUdEI04CL62LMLZthAgvdbgHw=
dataChangedSince
Only include metric types whose data has been updated since the date in question.
Example call
https://webservices.esd.org.uk/metricTypes?dataChangedSince=2013-12-20&ApplicationKey=ExamplePPK&Signature=11GxKETvZ940C51G0Iq8tHIp9r8=
dataset
Filter by metric types belonging to a particular dataset.
Example call
https://webservices.esd.org.uk/metricTypes?dataset=6&ApplicationKey=ExamplePPK&Signature=xxo5QFNojryJHa/N/CfdMWpSHbo=
filterOff
Setting the filter as being off means that any checks for whether data will be accessible to you will be ignored
Example call
https://webservices.esd.org.uk/metricTypes?dataset=6&filterOff=1&ApplicationKey=ExamplePPK&Signature=4yCcz+ZPoVcMNmmOF617o518lhY=
measurementUnit
Filter by metric types of a particular measurement type.
Example call
https://webservices.esd.org.uk/metricTypes?measurementUnit=Quantity_1000_pounds&ApplicationKey=ExamplePPK&Signature=Grvu5bc/+bIH1JNjBwIWvQKAW2g=
metadataChangedSince
Only include metric types whose metadata has been updated since the date in question.
Example call
https://webservices.esd.org.uk/metricTypes?metadataChangedSince=2013-12-20&ApplicationKey=ExamplePPK&Signature=rqcjBqvsBSa4jNmp6GGqqOEYwVA=
metadataOrDataChangedSince
Only include metric types whose data or metadata has changed since the day in question.
Example call
https://webservices.esd.org.uk/metricTypes?metadataOrDataChangedSince=2013-12-20&ApplicationKey=ExamplePPK&Signature=CtPnuoJCsJAVu04U0pwPyU0B5RY=



/metricTypes/denominators

Shows metrics used as denominators for a specified area type.

Parameters

areaType
Filter results by an area type.
Example call
https://webservices.esd.org.uk/metricTypes/denominators?areaType=Region&ApplicationKey=ExamplePPK&Signature=8YEnLo+4o46n27l7Hr7F9QKDhsc=



/metricTypes/filter-data

Show metric types applicable to area types within a given area.

Parameters

area
Specify area code.
Example call
https://webservices.esd.org.uk/metricTypes/filter-data?area=E07000070&ApplicationKey=ExamplePPK&Signature=FRxsSMgWm6853yhGlJb/vi3ggbQ=
excludeParentArea
Exclude parent area type from results.
Example call
https://webservices.esd.org.uk/metricTypes/filter-data?area=E07000070&excludeParentArea=true&ApplicationKey=ExamplePPK&Signature=vojMw6cIOr4AtJJ4ZHjm0e+Vww4=



/metricTypes/forBreakdown

Returns a list of all metric types plus "pseudo" metric types to represent datasets where there is no metric type to represent 100% of the data. Pseudo metric types will be created for e.g. % of population by ethnicity where there is no metric type representing 100%. This method will return for each metric type (real and pseudo):identifier, label, indicator if the metric type is real or pseudo, flag to denote if there is a breakdown.

Example call




/metricTypes/search

Search through the metric types.

Example call

Parameters

q
The search term to filter the results by.
Example call
https://webservices.esd.org.uk/metricTypes/search?q=population&ApplicationKey=ExamplePPK&Signature=qyoTi9MP3AX4Uo/Nu8ip/pYHGgs=
type
Filter results by type of item. In this case all results are "metricType", so adding a type will not further filter the results.
Example call
https://webservices.esd.org.uk/metricTypes/search?q=population&type=metricType&ApplicationKey=ExamplePPK&Signature=XczAP53aMRSDhzAOjKQTUxqxtWw=



/metricTypes/updates.rss

A feed of metric types with new and changed metric type definitions and/or metric values. Without any parameters, metric types updated last night will be shown

Example call




/metricTypes/{identifier}

Returns details of a specified metric type. Including the latest and earliest period for each area type applicable to the metric type.

Example call




/organisations

Returns basic details of organisations. With no parameters - will return a full list of organisations

Parameters

area
Return the local authorities responsible for the areas within which a specified GSS code or postcode comes.
Example call
https://webservices.esd.org.uk/organisations?area=sw98bj&ApplicationKey=ExamplePPK&Signature=4P6N85E7sLjTGwTpabZaihg6hOY=
areaName
Return organisations that match an area name.
Example call
https://webservices.esd.org.uk/organisations?areaName=city&ApplicationKey=ExamplePPK&Signature=KTB1hhg+lbBUTK1yftiZGmocJwI=
areaOwnersOnly
Return only organisations that are associated with a specific geographical area. This includes organisations such as local authorities and fire organisations, but not national organisations.
Example call
https://webservices.esd.org.uk/organisations?areaOwnersOnly=true&area=E09000031&ApplicationKey=ExamplePPK&Signature=IDN41LCaHBcfwsI/ZHAfTbkKT4Y=
areaType
Filter results to a particular area type.
informAccessOnly
Return only organisations that have have access to LG Inform.
Example call
https://webservices.esd.org.uk/organisations?informAccessOnly=true&ApplicationKey=ExamplePPK&Signature=LknEy4N0xK06ZlBw1t449tb5J6g=



/organisations/verbose

Full details of all organisations.




/organisations/{identifier}

Returns all details of one organisation, using the organisations metacode as an identifier.

Example call




/outliers/{identifier}

Returns all metric types whose value is 2 or more standard deviations from the mean for all English local authorities.

Example call

Parameters

area
A list of areas or a comparison group over which statistics should be calculated. The default is the comparison group "AllLaInCountry_England"
Example call
https://webservices.esd.org.uk/outliers/E06000039?area=Core_English_Cities&ApplicationKey=ExamplePPK&Signature=QyolBmTI/6u4caLhd22vDaz0OJ0=
customBands
The custom threshold values beneath and/or above which outliers are defined. If more than two are used, only the first and/or last is considered.
Example call
https://webservices.esd.org.uk/outliers/E06000039?customBands=100,300&ApplicationKey=ExamplePPK&Signature=6eB1bACbt+Vca1E1T6qprbKkkBE=
metricType
A single metric type identifier, a comma separated list of metric type identifiers or a metric dimension identifier
Example call
https://webservices.esd.org.uk/outliers/E06000039?metricType=3531&ApplicationKey=ExamplePPK&Signature=4E5mltckZRBzPu6BapwiL2dS4hg=
number
The minimum number of bands for quantiles and equal ranges (is the valueType parameter is set to either of these) OR the number of standard deviations from the mean. This defaults to 4 for all bands and 2 for standard deviations.
Example call
https://webservices.esd.org.uk/outliers/E06000039?number=3&ApplicationKey=ExamplePPK&Signature=vH77YRt6Tw9ma65juH8eIJnpK2A=
outlierType
First or last defaulting to both - first includes only outliers less than the mean, last includes those greater.
Example call
https://webservices.esd.org.uk/outliers/E06000039?outlierType=first&ApplicationKey=ExamplePPK&Signature=cpkdc0urjR17oi1renkNIQsGeVw=
valueType
The means of defining bands, which must be one of: band for quantiles, equalRanges for equal ranges, standardDeviations for standard deviations (which is the default), and customBand for custom bands.
Example call
https://webservices.esd.org.uk/outliers/E06000039?valueType=equalRanges&ApplicationKey=ExamplePPK&Signature=r9xBPWEY/CP2RspwI2oXds01q8Y=



/periodTypes

Returns time period types used by the system.

Example call




/periodTypes/verbose

Full details of all time period types used by the system.

Example call




/periodTypes/{identifier}

Full details of a single specified time period type.

Example call




/periods

Returns time periods. No parameters returns all available time periods.

Example call

Parameters

excludeFuturePeriods
Exclude any time periods which are in the future.
Example call
https://webservices.esd.org.uk/periods?periodType=CalendarYear&excludeFuturePeriods=1&ApplicationKey=ExamplePPK&Signature=zf4idcbl/GeBozcA5gtfWvHmDM0=
periodType
Only return time periods of a particular time period type.
Example call
https://webservices.esd.org.uk/periods?periodType=CalendarYear&ApplicationKey=ExamplePPK&Signature=uVrE5V1LPT9dgI5gTu8Q40kgHOM=



/periods/filter-data

Filters time periods by data availability specified in parameters. At minimum a metricType parameter is required.

Parameters

area
Time periods for which a particular area or comparison group has metric type values.
Example call
https://webservices.esd.org.uk/periods/filter-data?metricType=3&area=AllLAInRegion_London&ApplicationKey=ExamplePPK&Signature=RYb1oO5OPU0SRjjLitMI3m5D7Xs=
areaType
Only include time dates for a particular area type.
Example call
https://webservices.esd.org.uk/periods/filter-data?metricType=1&area=AllLAInCountry_England&areaType=LondonBorough&ApplicationKey=ExamplePPK&Signature=qgSmZ2fbfjUxMPuPvWOw3lZJFyM=
from
Include time periods from a particular time period onwards.
Example call
https://webservices.esd.org.uk/periods/filter-data?metricType=3&area=AllLAInRegion_London&from=sch_2011_12&ApplicationKey=ExamplePPK&Signature=RdPu2mGs/oqMAffbUcGhp5+dRfs=
includeMissing
Include time periods which do not have values but fill gaps, so time periods are consecutive. By default missing time periods are included.
Example call
https://webservices.esd.org.uk/periods/filter-data?metricType=11&area=E06000053&includeMissing=0&ApplicationKey=ExamplePPK&Signature=BMAqlR/9IYVFZrX+lDSHPY+efyw=
metricDimension
Filter to periods applicable to a specific metric dimension.
Example call
https://webservices.esd.org.uk/periods/filter-data?metricDimension=[531][531_Standardised_mortality_ratio][Disease]&ApplicationKey=ExamplePPK&Signature=Om8vYrQg2NPHg22/ErdjlJag5dU=
metricType
Filters time periods for which a particular metric type has values.
Example call
https://webservices.esd.org.uk/periods/filter-data?metricType=1&ApplicationKey=ExamplePPK&Signature=Kj1522hTEdRBYgAl3bXrX9KE0Lo=
strict
Setting to 0 means when including an area group, only a single area needs to have a value for the time period to be returned. Without this where an area group is specified, all areas need to have a value for the time period to be included.
Example call
https://webservices.esd.org.uk/periods/filter-data?metricType=3&area=AllLAInRegion_London&strict=0&ApplicationKey=ExamplePPK&Signature=0wfdP3ECHDEd3ozyUyvt5ztc6vg=
to
Include time periods up until a particular time period.
Example call
https://webservices.esd.org.uk/periods/filter-data?metricType=3&area=AllLAInRegion_London&to=sch_2011_12&ApplicationKey=ExamplePPK&Signature=h8Z2GIm7xp4uDIgsoack1/h+wO8=



/periods/{identifier}

Full details of a particular time period.

Example call




/shapes

Returns a single KML file containing all of the shapes listed.

Parameters

area
Returns the KML for the area or comparison group.
Example call
https://webservices.esd.org.uk/shapes?area=E09000031&ApplicationKey=ExamplePPK&Signature=FRvpLuiiHSjiplDLzqfRgebo+yg=
changedSince
Only include shapes whose data has been updated since the specified date
Example call
https://webservices.esd.org.uk/shapes?area=AllLAInRegion_London&changedSince=2012-06-15&ApplicationKey=ExamplePPK&Signature=XC3oOdW9tI5RaktNvIPCpr27Yo8=
pageNumber
Larger calls can be split into different pages. All calls are automatically limited to 500 areas. Use this attribute to find subsequent pages.
Example call
https://webservices.esd.org.uk/shapes?area=AllBoroughInRegion_London&pageNumber=2&pageSize=1&ApplicationKey=ExamplePPK&Signature=zQ9UlrzBvbX7WPBG8cEXgd9Lw9c=
pageSize
Limit the number of areas returned in each KML file.
Example call
https://webservices.esd.org.uk/shapes?area=AllBoroughInRegion_London&pageNumber=2&pageSize=1&ApplicationKey=ExamplePPK&Signature=zQ9UlrzBvbX7WPBG8cEXgd9Lw9c=



/subjects

Subjects which have associated metric types.

Example call




/subjects/verbose

Full details for all subjects, including associated metric types.

Example call




/subjects/{identifier}

Returns subject details, including a flat list of descendant subjects at any level (not just direct children). Every subject in a list includes information about its direct parent/parents. Metric types associated with the specified subject are given. Descandants and parents are sorted in alphabetical order of subject label.

Example call




/textToken

This web method should not be used on its own. Text token web methods retrieve small strings of text which are used to be inserted into reports based on the variables in the parameters.




/textToken/compare

Text describing if one value is greater than, equal to or less than another. The text is user-defined meaning that synonyms can be used, e.g. higher, identical, lower, etc. Most useful for comparing means, medians, percentages, etc., rather than absolute values or totals, for example, the percentage of pensioners within a ward that live alone compared to those in the country.

Parameters

area
Filter areas by comparison group or GSS code.
Example call
https://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=DhNgWBRk92H+fzuYNxapAy5IkT4=
equal
Customise output when compared areas are equal. Defaults to 'equal to'.
Example call
https://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E92000001&withArea=E92000001&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=LAv20HquRhAk0IAcunkMCzDfZ6s=
greater
Customise output when area is greater than compared area. Defaults to 'greater than'.
Example call
https://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E92000001&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=f534VJ9j7bX/dwb3JoKDVT3Nk9A=
less
Customise output when area is less than compared area. Defaults to 'less than'.
Example call
https://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E12000008&withArea=E92000001&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=G4Sd/MLer8rk4xNop44C/911VZI=
metricType
Filter by metric type.
Example call
https://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=DhNgWBRk92H+fzuYNxapAy5IkT4=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
https://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&period=latest&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=dcjwxSh2rrSv8ZN0WTpAnU8lgGE=
summaryType
Filter by summary type. Defaults to mean.
Example call
https://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&summaryType=mean&withSummaryType=mean&period=latest&withPeriod=latest&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=3XUHARe8U+vA3mESawdRux0UOLM=
withArea
Choose area for this specific comparison.
Example call
https://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=DhNgWBRk92H+fzuYNxapAy5IkT4=
withPeriod
Choose period for this specific comparison. Defaults to 'latest'.
Example call
https://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&period=latest&withPeriod=latest&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=3vr4rI8riUj0gfmeCJ6hodexO9U=
withSummaryType
Choose summary type for this specific comparison. Defaults to mean.
Example call
https://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&summaryType=mean&withSummaryType=mean&period=latest&withPeriod=latest&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=3XUHARe8U+vA3mESawdRux0UOLM=



/textToken/countAreas

A count of the area types in a given bounding area. For example, the number of wards within an authority.

Parameters

area
Choose area following by area type to be counted.
Example call
https://webservices.esd.org.uk/textToken/countAreas?area=E92000001:Region&ApplicationKey=ExamplePPK&Signature=I9jhVTGvRir5QLWTDXmidX7kRdI=



/textToken/derived

A method for extracting derived values (for example sums, and averages) for a metric type.

Parameters

area
Filter areas by comparison group or GSS code.
Example call
https://webservices.esd.org.uk/textToken/derived?metricType=201&area=E09000010&withArea=AllBoroughInRegion_London&ApplicationKey=ExamplePPK&Signature=nb3Kylt54nei/nOQ8Cpc3jirECo=
metricType
Filter by metric type.
Example call
https://webservices.esd.org.uk/textToken/derived?metricType=201&area=E09000010&withArea=AllBoroughInRegion_London&ApplicationKey=ExamplePPK&Signature=nb3Kylt54nei/nOQ8Cpc3jirECo=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
https://webservices.esd.org.uk/textToken/derived?metricType=201&area=E09000010&withArea=AllBoroughInRegion_London&period=latest&ApplicationKey=ExamplePPK&Signature=82bcAFffzQ06LTRl6hVW594H27Q=
valueType
Choose type of value to be used in summary. Defaults to 'raw'.
Example call
https://webservices.esd.org.uk/textToken/derived?metricType=201&area=E09000010&withArea=AllBoroughInRegion_London&valueType=rank&ApplicationKey=ExamplePPK&Signature=Ndcx3kXVz1Nl+Pnmzo+7GiAcJI4=
virtualMetricType.denominator
Metric ID for denominator in virtual metric.
Example call
https://webservices.esd.org.uk/textToken/derived?area=E09000010&withArea=AllBoroughInRegion_London&virtualMetricType.denominator=176&virtualMetricType.multiple=10&virtualMetricType.numerator=1&ApplicationKey=ExamplePPK&Signature=NDl20zDUJ4WOrXVG9EG6r5srOPY=
virtualMetricType.label
Specify a label for your virtual metric.
Example call
https://webservices.esd.org.uk/textToken/derived?area=E09000010&withArea=AllBoroughInRegion_London&virtualMetricType.denominator=176&virtualMetricType.multiple=10&virtualMetricType.numerator=1&virtualMetricType.label=VM Test&ApplicationKey=ExamplePPK&Signature=DXUjH0dBvmLYK/ywxW0OpQp+SeE=
virtualMetricType.multiple
Number for multiple in virtual metric.
Example call
https://webservices.esd.org.uk/textToken/derived?area=E09000010&withArea=AllBoroughInRegion_London&virtualMetricType.denominator=176&virtualMetricType.multiple=10&virtualMetricType.numerator=1&ApplicationKey=ExamplePPK&Signature=NDl20zDUJ4WOrXVG9EG6r5srOPY=
virtualMetricType.numerator
Metric ID for numerator in virtual metric.
Example call
https://webservices.esd.org.uk/textToken/derived?area=E09000010&withArea=AllBoroughInRegion_London&virtualMetricType.denominator=176&virtualMetricType.multiple=10&virtualMetricType.numerator=1&ApplicationKey=ExamplePPK&Signature=NDl20zDUJ4WOrXVG9EG6r5srOPY=
withArea
Area or comparison group for second value in calculation. Either this or withPeriod must be specified, unless the valueType is percentDifferenceFromEquivalent or percentDifferenceFromLast.
Example call
https://webservices.esd.org.uk/textToken/derived?metricType=201&area=E09000010&withArea=AllBoroughInRegion_London&ApplicationKey=ExamplePPK&Signature=nb3Kylt54nei/nOQ8Cpc3jirECo=
withPeriod
Period identfier for second value in calculation. Either this or withArea must be specified, unless the valueType is percentDifferenceFromEquivalent or percentDifferenceFromLast.



/textToken/equivalent

The equivalent value in a chosen area of the predominant circumstance collection in the area covered by the report. For example, if the predominant gender in a lower-level area is male, this token can return the equivalent value for males in the region.

Parameters

area
Filter areas by comparison group or GSS code
Example call
https://webservices.esd.org.uk/textToken/equivalent?metricDimension=[424][424_PercentageofONSpopulationcount][Agestructure]&area=E07000064&for=E10000011&ApplicationKey=ExamplePPK&Signature=2fLXkdcsclIYkkSkmdIGTcvPrz0=
for
Area for which equivalent area is read.
Example call
https://webservices.esd.org.uk/textToken/equivalent?metricDimension=[424][424_PercentageofONSpopulationcount][Agestructure]&area=E07000064&for=E10000011&ApplicationKey=ExamplePPK&Signature=2fLXkdcsclIYkkSkmdIGTcvPrz0=
metricDimension
Filter by group of related metrics.
Example call
https://webservices.esd.org.uk/textToken/equivalent?metricDimension=[424][424_PercentageofONSpopulationcount][Agestructure]&area=E07000064&for=E10000011&ApplicationKey=ExamplePPK&Signature=2fLXkdcsclIYkkSkmdIGTcvPrz0=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
https://webservices.esd.org.uk/textToken/equivalent?metricDimension=[424][424_PercentageofONSpopulationcount][Agestructure]&area=E07000064&for=E10000011&period=cen_2011&ApplicationKey=ExamplePPK&Signature=gDWqUBE/UJwZG2k7sHncL+OOSKg=
rank
Filter by rank within an area. Defaults to top rank.
Example call
https://webservices.esd.org.uk/textToken/equivalent?metricDimension=[424][424_PercentageofONSpopulationcount][Agestructure]&area=E07000064&for=E10000011&rank=2&ApplicationKey=ExamplePPK&Signature=RO3YrtWccL708xal4RHr5FOrITk=
returnValue
Format of returned value. Defaults to 'value'.
Example call
https://webservices.esd.org.uk/textToken/equivalent?metricDimension=[424][424_PercentageofONSpopulationcount][Agestructure]&area=E07000064&for=E10000011&returnValue=valueWithUnits&ApplicationKey=ExamplePPK&Signature=sDM2QqML1JpwIHdIJiN/RwevIh8=



/textToken/evaluate

Evaluates a text token. The "eval" parameter is the token you want evaluated, and the "area" parameter is the area you are interested in.

Parameters

area
Main area for text token to be evaulated against.
Example call
https://webservices.esd.org.uk/textToken/evaluate?eval={=countAreas?area={region-identifier}:{parent-area-type-identifier}}&area=E07000064&ApplicationKey=ExamplePPK&Signature=8tIJuPJUjoUWwvyLsUCPlB8AAD8=
areaTypeMax
Specify highest level area type to use in hierarchy.
Example call
https://webservices.esd.org.uk/textToken/evaluate?eval={ancestor-2-type-short-label-nocaps}&area=E10000012&areaTypeMax=Country&ApplicationKey=ExamplePPK&Signature=/qxRQdGqHZ/Z7tfNrXtSlkw4qjk=
authorityArea
Authority area for text token to be evaulated against.
Example call
https://webservices.esd.org.uk/textToken/evaluate?eval={=countAreas?area={region-identifier}:{parent-area-type-identifier}}&area=E05003966&authorityArea=E07000064&ApplicationKey=ExamplePPK&Signature=x96jTxmhx8L4mKgznmbr+yC02lI=
childArea
Child area for text token to be evaulated against.
Example call
https://webservices.esd.org.uk/textToken/evaluate?eval={=countAreas?area={region-identifier}:{parent-area-type-identifier}}&area=E05003966&childArea=E05003966&ApplicationKey=ExamplePPK&Signature=lcVhD6okhGZ7IWe8/uIiGvYkU7o=
comparisonGroup
Specify comparison group for use in token.
Example call
https://webservices.esd.org.uk/textToken/evaluate?eval={=compare?metricType=1}&area=E10000012&comparisonGroup=AllCountiesInCountry_England&ApplicationKey=ExamplePPK&Signature=tBilEmLK4ygKkX204fn+1rIIVLE=
eval
Text token to be evaluated in report writer syntax. Examples of calls that can be used are "countAreas", "comparison-group-identifier", "comparison-group-label", "period-identifier", "period-label", "period-type-identifier", "period-type-label", "metric-type-identifier", and "metric-type-label". Ampersands need converting to "%26".
Example call
https://webservices.esd.org.uk/textToken/evaluate?eval={=countAreas?area={region-identifier}:{parent-area-type-identifier}}&area=E07000064&ApplicationKey=ExamplePPK&Signature=8tIJuPJUjoUWwvyLsUCPlB8AAD8=
includeChildArea
Toggle inclusion of child areas in calculation.
Example call
https://webservices.esd.org.uk/textToken/evaluate?eval={=countAreas}&area=E10000012&includeChildArea=1&ApplicationKey=ExamplePPK&Signature=E/2Zzl+ZOvFC/XjjnRwo+me84lM=
latestPeriod
Specify latest time period to use in token calculation.
Example call
https://webservices.esd.org.uk/textToken/evaluate?eval={=value}&area=E10000012&metricType=1&latestPeriod=cal_2013&ApplicationKey=ExamplePPK&Signature=0eF4iw62GT9ygZQwQCx3S2hDARk=
metricDimension
Specify default metric dimension to use in token calculation.
Example call
https://webservices.esd.org.uk/textToken/evaluate?eval={=rankedMetricType}&area=E10000012&metricType=1&metricDimension=[161][161_PerCent][Gender]&ApplicationKey=ExamplePPK&Signature=LMKQ3wSynM7563ex8dxvl4LXuXY=
metricType
Specify default metric type to use in token calculation.
Example call
https://webservices.esd.org.uk/textToken/evaluate?eval={=value}&area=E10000012&metricType=1&ApplicationKey=ExamplePPK&Signature=QddWvdCLhapzDw/mNXQvr/0Uzrw=
showNoValueAsNull
Return nothing when no value exists.
Example call
https://webservices.esd.org.uk/textToken/evaluate?eval={=rankedArea?rank=101}&area=E09000033:AdministrativeWard&metricType=3162&metricDimension=[161][161_PerCent][Gender]&showNoValueAsNull=true&ApplicationKey=ExamplePPK&Signature=YAFvIDpTnPa1BTxlTu2zDXGGruM=



/textToken/metricTypeMetadata

Details about a selected metric type. Returns the metric type's title (label) by default but can be configured to return a short title, data source, metric collection, a description of the metric type, its polarity rule or the data it was last updated.

Parameters

metricType
Filter by metric type.
Example call
https://webservices.esd.org.uk/textToken/metricTypeMetadata?metricType=1&ApplicationKey=ExamplePPK&Signature=7/NnJ2Xxy+zeoKBHi4LP/L5AwU4=
returnValue
The type of metadata to return. Defaults to 'label'.
Example call
https://webservices.esd.org.uk/textToken/metricTypeMetadata?metricType=1&returnValue=helpText&ApplicationKey=ExamplePPK&Signature=XjwXuXsJENROsQkY6JHJJGmRjuk=



/textToken/percent

The value of an area's metric displayed as a percentage of another area's value.

Parameters

area
Filter areas by comparison group or GSS code
Example call
https://webservices.esd.org.uk/textToken/percent?metricType=1&area=E10000002&withArea=AllCountiesInCountry_England&ApplicationKey=ExamplePPK&Signature=pp/44ZYkM6qgwPxtYErVTbPi2nc=
metricType
Filter by metric type.
Example call
https://webservices.esd.org.uk/textToken/percent?metricType=1&area=E10000002&withArea=AllCountiesInCountry_England&ApplicationKey=ExamplePPK&Signature=pp/44ZYkM6qgwPxtYErVTbPi2nc=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
https://webservices.esd.org.uk/textToken/percent?metricType=1&area=E10000002&withArea=AllCountiesInCountry_England&period=cal_2013&ApplicationKey=ExamplePPK&Signature=GGX5rTHxcPyMgBfa9x1ZOHCUOo0=
withArea
Area or comparison group for second value in percentage calculation. Either this or withPeriod must be specified.
Example call
https://webservices.esd.org.uk/textToken/percent?metricType=1&area=E10000002&withArea=AllCountiesInCountry_England&withPeriod=cal_2013&ApplicationKey=ExamplePPK&Signature=h7stYO4SSslS5ox3K+97FmkAYmk=
withPeriod
Period identifier for second value in percentage calculation. Either this or withArea must be specified. Defaults to 'latest'.
Example call
https://webservices.esd.org.uk/textToken/percent?metricType=1&area=E10000002&withArea=AllCountiesInCountry_England&withPeriod=cal_2013&ApplicationKey=ExamplePPK&Signature=h7stYO4SSslS5ox3K+97FmkAYmk=



/textToken/rankedArea

The nth ranked area within a bounding area for a specified metric type. Defaults to show child area's rank in parent area.

Parameters

area
Filter areas by comparison group or GSS code
Example call
https://webservices.esd.org.uk/textToken/rankedArea?metricType=1&area=AllBoroughInRegion_London&ApplicationKey=ExamplePPK&Signature=Ajz2q6t9HMZGiRT5Uh5n2NuKOhM=
metricType
Filter by metric type.
Example call
https://webservices.esd.org.uk/textToken/rankedArea?metricType=1&area=AllBoroughInRegion_London&ApplicationKey=ExamplePPK&Signature=Ajz2q6t9HMZGiRT5Uh5n2NuKOhM=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
https://webservices.esd.org.uk/textToken/rankedArea?metricType=1&area=AllBoroughInRegion_London&period=latest&ApplicationKey=ExamplePPK&Signature=Vjoib8VcA8LMa3HyWuSyBJeK78I=
rank
Desired rank. Defaults to top.
Example call
https://webservices.esd.org.uk/textToken/rankedArea?metricType=1&area=AllBoroughInRegion_London&rank=2&ApplicationKey=ExamplePPK&Signature=ykOVwvNnVkf9GjU+CZFFhK0LhOs=
returnValue
Format of returned value. Defaults to 'label'.
Example call
https://webservices.esd.org.uk/textToken/rankedArea?metricType=1&area=AllBoroughInRegion_London&rank=2&returnValue=ValueWithUnits&ApplicationKey=ExamplePPK&Signature=rnfBXw+1n6Gar8k4XsZGK/RanZw=
showNoValueAsNull,
Return empty result when there is no value.
Example call
https://webservices.esd.org.uk/textToken/rankedArea?metricType=3162&returnValue=shortLabel&area=E09000033:AdministrativeWard&rank=4&showNoValueAsNull=true&ApplicationKey=ExamplePPK&Signature=6nvdOo389GEGb/nNaInJ0nsPTfk=
virtualMetricType.denominator
Specify denominator metric ID to use in virtual metric calculation.
Example call
https://webservices.esd.org.uk/textToken/rankedArea?virtualMetricType.denominator=442&virtualMetricType.multiple=100&virtualMetricType.numerator=1&area=E07000070:AdministrativeWard&period=latest&ApplicationKey=ExamplePPK&Signature=nGz1HdYuWD5yUVhDCHjKpT4MghA=
virtualMetricType.multiple
Specify a multiple for your virtual metric calculation.
Example call
https://webservices.esd.org.uk/textToken/rankedArea?virtualMetricType.denominator=442&virtualMetricType.multiple=100&virtualMetricType.numerator=1&area=E07000070:AdministrativeWard&period=latest&ApplicationKey=ExamplePPK&Signature=nGz1HdYuWD5yUVhDCHjKpT4MghA=
virtualMetricType.numerator
Specify numerator metric ID to use in virtual metric calculation.
Example call
https://webservices.esd.org.uk/textToken/rankedArea?virtualMetricType.denominator=442&virtualMetricType.multiple=100&virtualMetricType.numerator=1&area=E07000070:AdministrativeWard&period=latest&ApplicationKey=ExamplePPK&Signature=nGz1HdYuWD5yUVhDCHjKpT4MghA=



/textToken/rankedMetricType

The nth ranked label or value of a metric dimension for an area. Most useful for displaying predominant groups. It's easiest to build these tokens using the text token editor.

Parameters

area
Filter by metric type.
Example call
https://webservices.esd.org.uk/textToken/rankedMetricType?metricDimension=[37][37_PerCent][Ethnicity]&area=AllBoroughInRegion_London&ApplicationKey=ExamplePPK&Signature=FhF3lmxoNwEoIuVNQFnZnM0VdPc=
metricDimension
Filter by group of related metrics.
Example call
https://webservices.esd.org.uk/textToken/rankedMetricType?metricDimension=[37][37_PerCent][Ethnicity]&area=AllBoroughInRegion_London&ApplicationKey=ExamplePPK&Signature=FhF3lmxoNwEoIuVNQFnZnM0VdPc=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
https://webservices.esd.org.uk/textToken/rankedMetricType?metricDimension=[37][37_PerCent][Ethnicity]&area=AllBoroughInRegion_London&period=latest&ApplicationKey=ExamplePPK&Signature=3+bIiehRJR39J9Xtg8U4FsCrs+U=
rank
Desired rank. Defaults to top.
Example call
https://webservices.esd.org.uk/textToken/rankedMetricType?metricDimension=[37][37_PerCent][Ethnicity]&area=AllBoroughInRegion_London&rank=2&ApplicationKey=ExamplePPK&Signature=QDvOa+RV+aleLsYHgoHKSONigls=
returnValue
Format of returned value. Defaults to 'label'.
Example call
https://webservices.esd.org.uk/textToken/rankedMetricType?metricDimension=[37][37_PerCent][Ethnicity]&area=AllBoroughInRegion_London&returnValue=ValueWithUnits&ApplicationKey=ExamplePPK&Signature=knWBV8952UQ0SKIuItQR5+lpmZY=



/textToken/smallAreaChart

Chart showing how a metric breaks down within a users area

Parameters

area
Filter areas by comparison group or GSS code
metricType
Filter by metric type.
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.



/textToken/smallAreaMap

Map showing how a metric breaks down within a users area

Parameters

area
Filter areas by comparison group or GSS code
metricType
Filter by metric type.
period
Filter by a particular time period or select "latest" for the latest time period. Default to 'latest'.



/textToken/smallAreaTable

Table showing how a metric breaks down within a users area

Parameters

area
Filter areas by comparison group or GSS code
metricType
Filter by metric type.
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.



/textToken/summary

The summary value of a metric type for an area type within a bounding area. For example, the mean number of houses in a ward within a chosen region.

Parameters

area
Filter areas by comparison group or GSS code
Example call
https://webservices.esd.org.uk/textToken/summary?metricType=3259&area=E12000002:Unitary&ApplicationKey=ExamplePPK&Signature=O+GI7uC59JZkEchAhfc6RhjiZrg=
metricType
Filter by metric type.
Example call
https://webservices.esd.org.uk/textToken/summary?metricType=3259&area=E12000002:Unitary&ApplicationKey=ExamplePPK&Signature=O+GI7uC59JZkEchAhfc6RhjiZrg=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
https://webservices.esd.org.uk/textToken/summary?metricType=3259&area=E12000002:Unitary&period=latest&ApplicationKey=ExamplePPK&Signature=okGOdqb6ivHNOweWsDWOHemOTrI=
summaryType
Choose type of summary value needed. Defaults to 'sum'.
Example call
https://webservices.esd.org.uk/textToken/summary?metricType=3259&area=E12000002:Unitary&summaryType=mean&ApplicationKey=ExamplePPK&Signature=uZz0KC6XCyFs0+Mg6dlpxO2b6DI=
valueType
Choose type of value to be used in summary. Defaults to 'raw'.
Example call
https://webservices.esd.org.uk/textToken/summary?metricType=3259&area=E12000002:Unitary&valueType=rank&ApplicationKey=ExamplePPK&Signature=gIn2nhrKuplygjlLBRM9QC0KbGA=
virtualMetricType.denominator
Specify denominator metric ID to use in virtual metric calculation.
Example call
https://webservices.esd.org.uk/textToken/summary?virtualMetricType.denominator=442&virtualMetricType.multiple=100&virtualMetricType.numerator=1&area=E07000070:AdministrativeWard&period=latest&ApplicationKey=ExamplePPK&Signature=/gil1tR1nlC1dgIAP15rLvc9l8o=
virtualMetricType.label
Specify a label for your virtual metric.
Example call
https://webservices.esd.org.uk/textToken/summary?virtualMetricType.denominator=442&virtualMetricType.multiple=100&virtualMetricType.numerator=1&virtualMetricType.label=VM Test&area=E07000070:AdministrativeWard&period=latest&ApplicationKey=ExamplePPK&Signature=+vgvlDNm/IRCpcnbULMxxhNF5vs=
virtualMetricType.multiple
Specify a multiple for your virtual metric calculation.
Example call
https://webservices.esd.org.uk/textToken/summary?virtualMetricType.denominator=442&virtualMetricType.multiple=100&virtualMetricType.numerator=1&area=E07000070:AdministrativeWard&period=latest&ApplicationKey=ExamplePPK&Signature=/gil1tR1nlC1dgIAP15rLvc9l8o=
virtualMetricType.numerator
Specify numerator metric ID to use in virtual metric calculation.
Example call
https://webservices.esd.org.uk/textToken/summary?virtualMetricType.denominator=442&virtualMetricType.multiple=100&virtualMetricType.numerator=1&area=E07000070:AdministrativeWard&period=latest&ApplicationKey=ExamplePPK&Signature=/gil1tR1nlC1dgIAP15rLvc9l8o=



/textToken/value

Returns the value of a metric type for an area and period. Defaults to the latest figures for the ward.

Parameters

area
Filter areas by comparison group or GSS code
Example call
https://webservices.esd.org.uk/textToken/value?metricType=3259&area=E12000002&ApplicationKey=ExamplePPK&Signature=mVGBdmzCZjzA2+z5VtikiXJgvBg=
metricType
Filter by metric type.
Example call
https://webservices.esd.org.uk/textToken/value?metricType=3259&area=E12000002&ApplicationKey=ExamplePPK&Signature=mVGBdmzCZjzA2+z5VtikiXJgvBg=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
https://webservices.esd.org.uk/textToken/value?metricType=3259&area=E12000002&period=latest&ApplicationKey=ExamplePPK&Signature=7Lu8A2I2lVn0SAixSbUcGBobAHw=
returnValue
Format of returned value. Defaults to 'value'.
Example call
https://webservices.esd.org.uk/textToken/value?metricType=3259&area=E12000002&returnValue=ValueWithUnits&ApplicationKey=ExamplePPK&Signature=Ple3M/garTiRmvxXMxd3hoON+Vc=
virtualMetricType.denominator
Specify denominator metric ID to use in virtual metric calculation.
Example call
https://webservices.esd.org.uk/textToken/value?area=E10000012&virtualMetricType.denominator=1029&virtualMetricType.multiple=100&virtualMetricType.numerator=1&ApplicationKey=ExamplePPK&Signature=FE7cGIvjWHBvaQwC6W1q2c0rGa4=
virtualMetricType.label
Specify a label for your virtual metric.
Example call
https://webservices.esd.org.uk/textToken/value?area=E10000012&virtualMetricType.denominator=1029&virtualMetricType.multiple=100&virtualMetricType.numerator=1&virtualMetricType.label=VM Test&ApplicationKey=ExamplePPK&Signature=HyKh4Y06eFFORHl3soozFupG9WQ=
virtualMetricType.multiple
Specify a multiple for your virtual metric calculation.
Example call
https://webservices.esd.org.uk/textToken/value?area=E10000012&virtualMetricType.denominator=1029&virtualMetricType.multiple=100&virtualMetricType.numerator=1&ApplicationKey=ExamplePPK&Signature=FE7cGIvjWHBvaQwC6W1q2c0rGa4=
virtualMetricType.numerator
Specify numerator metric ID to use in virtual metric calculation.
Example call
https://webservices.esd.org.uk/textToken/value?area=E10000012&virtualMetricType.denominator=1029&virtualMetricType.multiple=100&virtualMetricType.numerator=1&ApplicationKey=ExamplePPK&Signature=FE7cGIvjWHBvaQwC6W1q2c0rGa4=



/users

Full list of all users

Parameters

application
Limit to users with access to a specific application.
area
Filter areas by comparison group or GSS code
organisation
List users from a particular organisation.
userStatus
Use "all" for all users, "active" for current active users, and "left" for users who have left.



/users/current

Returns details of current user, as identified by OAuth parameters




/users/verbose

Return full details from all users.

Parameters

userStatus
Use "all" for all users, "active" for current active users, and "left" for users who have left.



/users/{identifier}

Returns all details for user as included by user identifier

Example call




/valueTypes

Returns a grouping of summary or derived value types, such as sum, average, maximum, minimum, and median. Needs at least a group parameter.

Parameters

group
Name for the group of summary types.
Example call
https://webservices.esd.org.uk/valueTypes?group=esd_reports&ApplicationKey=ExamplePPK&Signature=0OGFWAnG/ci7jLrnC1X+i3/r6EU=
metricType
Filter by metric type or metric types.
Example call
https://webservices.esd.org.uk/valueTypes?group=esd_reports&metricType=1&ApplicationKey=ExamplePPK&Signature=eBWMjCr3LMqbKa6K0uF+MWmfqBs=



/valueTypes/verbose

Full list of the available summary or derived types.

Example call