This is the reference documentation for the Practice Sharing Platform API. Most API calls require an authentication token. To authenticate, take a look at the Profile, Billing and Access Control API reference documentation.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail.
Browse the API endpoints by ...
This section contains APIs related to assessments
This section contains APIs related to reporting
This section contains APIs related to content readers
This section contains APIs related to content editors
GET /api/content/
A page number within the paginated result set.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Account that can edit the page element
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl http://localhost:8040/api/content/{ "count": 8, "next": null, "previous": null, "results": [ { "slug": "metal", "path": null, "title": "Metal structures & equipment", "indent": 0 }, { "slug": "boxes-and-enclosures", "path": "/metal/boxes-and-enclosures", "title": "Boxes & enclosures", "indent": 1, "tags": [ "industry", "pagebreak", "public", "scorecard" ] } ] }
GET /api/content/comments/{path}
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Long description of the page element
curl http://localhost:8040/api/content/comments/adjust-air-fuel-ratio{ "count": 1, "next": null, "previous": null, "results": [ { "created_at": "2020-09-28T00:00:00.0000Z", "user": "steve", "text": "How long does it take to see improvements?" } ] }
POST /api/content/comments/{path}
Long description of the page element
Long description of the page element
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"text": "How long does it take to see improvements?"}' http://localhost:8040/api/content/comments/adjust-air-fuel-ratio{ "created_at": "2020-09-28T00:00:00.0000Z", "user": "steve", "text": "How long does it take to see improvements?" }
GET /api/content/detail/{path}
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Account that can edit the page element
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl http://localhost:8040/api/content/detail/adjust-air-fuel-ratio{ "slug": "adjust-air-fuel-ratio", "picture": null, "title": "Adjust air/fuel ratio", "text": "<h2>Background</h2><p>Some manufacturing processes may involve heating operations.</p>", "extra": null }
POST /api/content/downvote/{path}
The authenticated user making the request indicates the practice is not worth implementing.
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Title of the page element
Picture icon that can be displayed alongside the title
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Account that can edit the page element
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{}' http://localhost:8040/api/content/downvote/adjust-air-fuel-ratio{ "slug": "water-user", "title": "How to reduce water usage?" }
GET /api/content/editables/{profile}
This API endpoint lists page elements that are owned and thus editable by an account.
A search term.
Which field to use when ordering the results.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl http://localhost:8040/api/content/editables/alliance{ "count": 5, "next": null, "previous": null, "results": [ { "path": null, "title": "Construction", "tags": [ "public" ], "indent": 0 }, { "path": null, "title": "Governance & management", "picture": "https://assets.tspproject.org/management.png", "indent": 1 }, { "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "indent": 2, "extra": { "intrinsic_values": { "environmental_value": 1, "business_value": 1, "profitability": 1, "implementation_ease": 1, "avg_value": 1 } } }, { "path": null, "title": "Production", "picture": "https://assets.tspproject.org/production.png", "indent": 1 }, { "path": "/construction/production/adjust-air-fuel-ratio", "title": "Adjust Air fuel ratio", "indent": 2, "extra": { "intrinsic_values": { "environmental_value": 2, "business_value": 2, "profitability": 2, "implementation_ease": 2, "avg_value": 2 } } } ] }
POST /api/content/editables/{profile}
Title of the page element
Picture icon that can be displayed alongside the title
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"title": "Boxes enclosures"}' http://localhost:8040/api/content/editables/alliance{ "slug": "boxes-enclosures", "title": "Boxes enclosures" }
GET /api/content/editables/{profile}/campaigns/{campaign}
A search term.
Which field to use when ordering the results.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl http://localhost:8040/api/content/editables/envconnect/campaigns/sustainability{ "count": 5, "next": null, "previous": null, "results": [ { "path": null, "title": "Construction", "tags": [ "public" ], "indent": 0 }, { "path": null, "title": "Governance & management", "picture": "https://assets.tspproject.org/management.png", "indent": 1 }, { "path": "/construction/governance/the-assessment -process-is-rigorous", "title": "The assessment process is rigorous", "indent": 2 }, { "path": null, "title": "Production", "picture": "https://assets.tspproject.org/production.png", "indent": 1 }, { "path": "/construction/production/adjust-air-fuel -ratio", "title": "Adjust Air fuel ratio", "indent": 2 } ] }
POST /api/content/editables/{profile}/campaigns/{campaign}
Updates the title, text and, if applicable, the metrics associated associated to the content element referenced by path.
Title of the page element
Picture icon that can be displayed alongside the title
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"title": "Adjust air/fuel ratio", "parents": []}' http://localhost:8040/api/content/editables/alliance/campaigns/sustainability{ "title": "Adjust air/fuel ratio", "parents": [] }
GET /api/content/editables/{profile}/campaigns/{campaign}/segments
A page number within the paginated result set.
A search term.
Which field to use when ordering the results.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl http://localhost:8040/api/content/editables/alliance/campaigns/sustainability/segments{ "count": 5, "next": null, "previous": null, "results": [ { "path": null, "title": "Construction", "tags": [ "public" ], "indent": 0 }, { "path": null, "title": "Governance & management", "picture": "https://assets.tspproject.org/management.png", "indent": 1 }, { "path": "/construction/governance/the-assessment -process-is-rigorous", "title": "The assessment process is rigorous", "indent": 2 }, { "path": null, "title": "Production", "picture": "https://assets.tspproject.org/production.png", "indent": 1 }, { "path": "/construction/production/adjust-air-fuel -ratio", "title": "Adjust Air fuel ratio", "indent": 2 } ] }
POST /api/content/editables/{profile}/campaigns/{campaign}/segments
Title of the page element
Picture icon that can be displayed alongside the title
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"title": "Boxes enclosures"}' http://localhost:8040/api/content/editables/alliance/campaigns/sustainability/segments{ "slug": "boxes-enclosures" }
POST /api/content/editables/{profile}/campaigns/{campaign}/upload
Upload all practices, tiles and segments for a campaign from a CSV file.
Title of the page element
Picture icon that can be displayed alongside the title
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl -X POST http://localhost:8040/api/content/editables/alliance/campaigns/sustainability/upload{ "count": 5, "next": null, "previous": null, "results": [ { "path": null, "title": "Construction", "tags": [ "public" ], "indent": 0 }, { "path": null, "title": "Governance & management", "picture": "https://assets.tspproject.org/management.png", "indent": 1 }, { "path": "/construction/governance/the-assessment -process-is-rigorous", "title": "The assessment process is rigorous", "indent": 2 }, { "path": null, "title": "Production", "picture": "https://assets.tspproject.org/production.png", "indent": 1 }, { "path": "/construction/production/adjust-air-fuel -ratio", "title": "Adjust Air fuel ratio", "indent": 2 } ] }
GET /api/content/editables/{profile}/campaigns/{campaign}/{path}
Title of the question as displayed in user interfaces
Long form description about the question
Default unit for measured field when none is specified
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL
curl http://localhost:8040/api/content/editables/envconnect/campaigns/sustainability/construction/governance/the-assessment-process-is-rigorous{ "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": "assessment" }
POST /api/content/editables/{profile}/campaigns/{campaign}/{path}
Creates a new question under prefix path.
Title of the question as displayed in user interfaces
Long form description about the question
Default unit for measured field when none is specified
Extra meta data (can be stringify JSON)
Title of the question as displayed in user interfaces
Long form description about the question
Default unit for measured field when none is specified
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"title": "Adjust air/fuel ratio"}' http://localhost:8040/api/content/editables/alliance/campaigns/sustainability{ "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": "assessment" }
PUT /api/content/editables/{profile}/campaigns/{campaign}/{path}
Updates the title, text and, if applicable, the metrics associated associated to the content element referenced by path.
Title of the question as displayed in user interfaces
Long form description about the question
Default unit for measured field when none is specified
Extra meta data (can be stringify JSON)
Title of the question as displayed in user interfaces
Long form description about the question
Default unit for measured field when none is specified
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"title": "Adjust air/fuel ratio"}' http://localhost:8040/api/content/editables/alliance/campaigns/sustainability{ "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": "assessment" }
DELETE /api/content/editables/{profile}/campaigns/{campaign}/{path}
Deletes all questions under prefix path.
204 No Content
curl -X DELETE http://localhost:8040/api/content/editables/alliance/campaigns/sustainabilityGET /api/content/editables/{profile}/{path}
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Account that can edit the page element
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl http://localhost:8040/api/content/editables/boxes-enclosures/{ "slug": "boxes-enclosures", "path": "/boxes-enclosures", "text": "Hello" }
POST /api/content/editables/{profile}/{path}
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Title of the page element
Picture icon that can be displayed alongside the title
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Account that can edit the page element
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"title": "Boxes enclosures"}' http://localhost:8040/api/content/editables/boxes-enclosures/{ "slug": "boxes-enclosures", "text": "Hello" }
PUT /api/content/editables/{profile}/{path}
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Title of the page element
Picture icon that can be displayed alongside the title
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Account that can edit the page element
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl -X PUT -H 'Content-Type: application/json; charset=UTF-8' -d '{"title": "Boxes and enclosures"}' http://localhost:8040/api/content/editables/boxes-enclosures/{ "slug": "boxes-enclosures", "text": "Hello" }
DELETE /api/content/editables/{profile}/{path}
204 No Content
curl -X DELETE http://localhost:8040/api/content/editables/boxes-enclosures/POST /api/content/follow/{path}
The authenticated user making the request will receive notification whenever someone comments on the practice.
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Title of the page element
Picture icon that can be displayed alongside the title
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Account that can edit the page element
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{}' http://localhost:8040/api/content/follow/adjust-air-fuel-ratio{ "slug": "water-user", "title": "How to reduce water usage?" }
GET /api/content/search
A page number within the paginated result set.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Account that can edit the page element
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl http://localhost:8040/api/content/search{ "count": 1, "next": null, "previous": null, "results": [ { "slug": "hello", "path": "/hello", "title": "Hello" } ] }
POST /api/content/unfollow/{path}
The authenticated user making the request will stop receiving notification whenever someone comments on the practice.
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Title of the page element
Picture icon that can be displayed alongside the title
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Account that can edit the page element
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{}' http://localhost:8040/api/content/unfollow/adjust-air-fuel-ratio{ "slug": "water-user", "title": "How to reduce water usage?" }
POST /api/content/upvote/{path}
The authenticated user making the request indicates the practice is considered worthwhile implementing.
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Title of the page element
Picture icon that can be displayed alongside the title
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Account that can edit the page element
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{}' http://localhost:8040/api/content/upvote/adjust-air-fuel-ratio{ "slug": "water-user", "title": "How to reduce water usage?" }
GET /api/content/{path}
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in URL paths
Picture icon that can be displayed alongside the title
Title of the page element
Long description of the page element
Reading time of the material (in hh:mm:ss)
Account that can edit the page element
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl http://localhost:8040/api/content/boxes-and-enclosures{ "count": 8, "next": null, "previous": null, "results": [ { "slug": "metal", "path": null, "title": "Metal structures & equipment", "indent": 0 }, { "slug": "boxes-and-enclosures", "path": "/metal/boxes-and-enclosures", "title": "Boxes & enclosures", "indent": 1, "tags": [ "industry", "pagebreak", "public", "scorecard" ] } ] }
GET /api/units
This API end-point lists all the units of measurement available to record datapoints.
Alongside the usual metric units (meters, kilogram, etc.) and imperial units (inch, pounds, etc.), there could be units with a rank system (natural integers), or an enumerated system (finite set of values with no order). A special unit is used to represent free form text.
A page number within the paginated result set.
units that can be used intercheably with this one
value to search for in the fields specified by q_f
restrict searches to one or more fields in: slug, title. searches all fields when unspecified.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in a URL
Short description suitable for display
One of standard (metric system), imperial, rank, enum, or freetext
short name for the enumerated value (as used in source code)
long form description of the enumerated value (for help tooltips)
curl http://localhost:8040/api/units{ "count": 1, "previous": null, "next": null, "results": [ { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] } ] }
GET /api/units/{unit}
Retrieves the details of a Unit.
Unique identifier that can be used in a URL
Short description suitable for display
One of standard (metric system), imperial, rank, enum, or freetext
short name for the enumerated value (as used in source code)
long form description of the enumerated value (for help tooltips)
curl http://localhost:8040/api/units/assessment{ "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }
GET /api/{profile}/campaigns
Lists campaigns that belongs to a profile.
A page number within the paginated result set.
date/time in ISO format
date/time in ISO format
value to search for in the fields specified by q_f
restrict searches to one or more fields in: title. searches all fields when unspecified.
sort by created_at, title. If a field is preceded by a minus sign ('-'), the order will be reversed. Multiple 'o' parameters can be specified to produce a stable result.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
curl http://localhost:8040/api/alliance/campaigns{ "count": 1, "results": [ { "slug": "construction", "account": "alliance", "title": "Assessment on sustainable construction practices", "active": true } ] }
POST /api/{profile}/campaigns
Creates a campaign against which profiles can be assessed.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
If checked, correct answser are required
Title of the question as displayed in user interfaces
Long form description about the question
Default unit for measured field when none is specified
Extra meta data (can be stringify JSON)
Unique identifier that can be used in a URL
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
If checked, correct answser are required
Title of the question as displayed in user interfaces
Long form description about the question
Default unit for measured field when none is specified
Extra meta data (can be stringify JSON)
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"title": "Sustainable construction practices"}' http://localhost:8040/api/alliance/campaigns{ "slug": "sustainable-construction-practices", "title": "Sustainable construction practices" }
GET /api/{profile}/campaigns/{campaign}
Retrieves the details of a Campaign.
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
If checked, correct answser are required
Unique identifier that can be used in URL
Short description
Unique identifier that can be used in a URL
Short description suitable for display
One of standard (metric system), imperial, rank, enum, or freetext
short name for the enumerated value (as used in source code)
long form description of the enumerated value (for help tooltips)
Hint for the user interface on how to present the input field
curl http://localhost:8040/api/alliance/campaigns/sustainability{ "slug": "construction", "account": "alliance", "title": "Assessment on sustainable construction practices", "active": true, "quizz_mode": false, "questions": [ { "path": "/construction/product-design", "title": "Product Design", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, { "path": "/construction/packaging-design", "title": "Packaging Design", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" } ] }
DELETE /api/{profile}/campaigns/{campaign}
Removes a Campaign and all associated Sample. The underlying Answer that were grouped in a Sample remain present in the database. These Answer are just no longer grouped logically in a Sample.
204 No Content
curl -X DELETE http://localhost:8040/api/alliance/campaign/sustainabilityGET /api/{profile}/filters
A page number within the paginated result set.
A search term.
Which field to use when ordering the results.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Title for the filter
Extra meta data (can be stringify JSON)
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
curl http://localhost:8040/api/energy-utility/filters{ "count": 2, "next": null, "previous": null, "results": [ { "slug": "boxes-and-enclosures", "title": "Boxes & enclosures", "extra": "", "predicates": [ { "rank": 0, "operator": "startswith", "operand": "/metal/boxes-and-enclosures", "field": "extra", "selector": "keepmatching" } ], "likely_metric": null } ] }
GET /api/{profile}/filters/accounts
A page number within the paginated result set.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Title for the filter
Extra meta data (can be stringify JSON)
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
curl http://localhost:8040/api/supplier-1/filters/accounts{ "count": 1, "previous": null, "next": null, "results": [ { "slug": "supplier-1", "title": "Supplier 1", "extra": null, "predicates": [], "likely_metric": [], "results": [] } ] }
POST /api/{profile}/filters/accounts
Title for the filter
Extra meta data (can be stringify JSON)
Title for the filter
Extra meta data (can be stringify JSON)
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"title": "Supplier 1"}' http://localhost:8040/api/energy-utility/filters/accounts{ "slug": "supplier-1", "title": "Supplier 1", "extra": null, "predicates": [], "likely_metric": [], "results": [] }
GET /api/{profile}/filters/accounts/values
A page number within the paginated result set.
date/time in ISO format
date/time in ISO format
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
curl http://localhost:8040/api/supplier-1/filters/accounts/values{ "count": 0, "next": null, "previous": null, "results": [ { "created_at": "2020-01-01T00:00:00Z", "measured": 12, "unit": "tons" } ] }
GET /api/{profile}/filters/accounts/{editable_filter}
Title for the filter
Extra meta data (can be stringify JSON)
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
curl http://localhost:8040/api/energy-utility/filters/accounts/suppliers{ "slug": "suppliers", "title": "Energy utility suppliers", "extra": null, "predicates": [], "likely_metric": null, "results": [ { "facility": "Main factory", "fuel_type": "natural-gas", "allocation": "Energy utility", "created_at": null, "ends_at": null, "amount": 100, "unit": "mmbtu" } ] }
POST /api/{profile}/filters/accounts/{editable_filter}
Extra meta data (can be stringify JSON)
Extra meta data (can be stringify JSON)
curl -X PUT -H 'Content-Type: application/json; charset=UTF-8' -d '{"full_name": "Main"}' http://localhost:8040/api/energy-utility/filters/accounts/suppliers{ "slug": "main", "full_name": "Main" }
PUT /api/{profile}/filters/accounts/{editable_filter}
Title for the filter
Extra meta data (can be stringify JSON)
Title for the filter
Extra meta data (can be stringify JSON)
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
curl -X PUT -H 'Content-Type: application/json; charset=UTF-8' -d '{"title": "Energy utility suppliers", "predicates": []}' http://localhost:8040/api/energy-utility/filters/accounts/suppliers{ "slug": "suppliers", "title": "Energy utility suppliers", "extra": null, "predicates": [], "likely_metric": null, "results": [ { "facility": "Main factory", "fuel_type": "natural-gas", "allocation": "Energy utility", "created_at": null, "ends_at": null, "amount": 100, "unit": "mmbtu" } ] }
DELETE /api/{profile}/filters/accounts/{editable_filter}
204 No Content
curl -X DELETE http://localhost:8040/api/energy-utility/filters/accounts/suppliersGET /api/{profile}/filters/accounts/{editable_filter}/values
A page number within the paginated result set.
date/time in ISO format
date/time in ISO format
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
curl http://localhost:8040/api/supplier-1/filters/accounts/ghg-emissions/values{ "count": 0, "next": null, "previous": null, "results": [ { "created_at": "2020-01-01T00:00:00Z", "measured": 12, "unit": "tons" } ] }
POST /api/{profile}/filters/accounts/{editable_filter}/values
Records numeric measurements towards a specific metric.
When baseline_at is specified, the measurement refers to a relative value since baseline_at. When baseline_at is not specified, the intent is to record an absolute measurement at time created_at.
Unit the measured field is in
measurement in unit
Account this sample belongs to.
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
Account this sample belongs to.
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"created_at": "2020-01-01T00:00:00Z", "items": [{"slug": "main-factory", "measured": 12, "unit": "tons"}]}' http://localhost:8040/api/supplier-1/filters/accounts/ghg-emissions/values{ "created_at": "2020-01-01T00:00:00Z", "items": [ { "slug": "main-factory", "measured": 12, "unit": "tons" } ] }
GET /api/{profile}/filters/accounts/{editable_filter}/{rank}
Extra meta data (can be stringify JSON)
curl http://localhost:8040/api/energy-utility/filters/accounts/suppliers/1{ "slug": "main-factory", "full_name": "Main factory" }
PUT /api/{profile}/filters/accounts/{editable_filter}/{rank}
Extra meta data (can be stringify JSON)
Extra meta data (can be stringify JSON)
curl -X PUT -H 'Content-Type: application/json; charset=UTF-8' -d '{"full_name": "Main factory"}' http://localhost:8040/api/energy-utility/filters/accounts/suppliers/1{ "slug": "main-factory", "full_name": "Main factory" }
DELETE /api/{profile}/filters/accounts/{editable_filter}/{rank}
204 No Content
curl -X DELETE http://localhost:8040/api/energy-utility/filters/accounts/suppliers/1GET /api/{profile}/filters/questions
A page number within the paginated result set.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Title of the question as displayed in user interfaces
Long form description about the question
Default unit for measured field when none is specified
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL
curl http://localhost:8040/api/supplier-1/filters/questions{ "count": 1, "previous": null, "next": null, "results": [ { "path": "/construction/product-design", "title": "Product Design", "default_unit": "assessment", "ui_hint": "radio" } ] }
POST /api/{profile}/filters/questions
Title of the question as displayed in user interfaces
Long form description about the question
Default unit for measured field when none is specified
Extra meta data (can be stringify JSON)
Title of the question as displayed in user interfaces
Long form description about the question
Default unit for measured field when none is specified
Extra meta data (can be stringify JSON)
Unique identifier that can be used in URL
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"title": "Construction", "default_unit": "assessment", "path": "/construction/product-design"}' http://localhost:8040/api/energy-utility/filters/questions{ "title": "Construction", "default_unit": "assessment", "path": "/construction/product-design" }
GET /api/{profile}/filters/questions/{editable_filter}
Title for the filter
Extra meta data (can be stringify JSON)
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
curl http://localhost:8040/api/energy-utility/filters/questions/governance{ "slug": "governance", "title": "Governance questions", "predicates": [ { "rank": 1, "operator": "contains", "operand": "Energy", "field": "extra", "selector": "keepmatching" } ] }
PUT /api/{profile}/filters/questions/{editable_filter}
Title for the filter
Extra meta data (can be stringify JSON)
Title for the filter
Extra meta data (can be stringify JSON)
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
curl -X PUT -H 'Content-Type: application/json; charset=UTF-8' -d '{"slug": "governance", "title": "Governance questions", "predicates": [{"rank": 1, "operator": "contains", "operand": "Energy", "field": "extra", "selector": "keepmatching"}]}' http://localhost:8040/api/energy-utility/filters/questions/governance{ "slug": "governance", "title": "Governance questions", "predicates": [ { "rank": 1, "operator": "contains", "operand": "Energy", "field": "extra", "selector": "keepmatching" } ] }
DELETE /api/{profile}/filters/questions/{editable_filter}
204 No Content
curl -X DELETE http://localhost:8040/api/energy-utility/filters/questions/governanceGET /api/{profile}/metrics/aggregate/{path}
date/time in ISO format
date/time in ISO format
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
curl http://localhost:8040/api/supplier-1/metrics/aggregate/ghg-emissions{ "created_at": "2020-01-01T00:00:00Z", "measured": 12, "unit": "tons" }
GET /api/{profile}/portfolios
Lists all grants and requests that have to be accepted or denied by account.
If you want to get all requests that have been initiated by account, see /api/{account}/requests. If you want to get all grants that have been initiated account, see /api/{account}/grants.
A page number within the paginated result set.
filter by state (grant-initiated, grant-accepted, grant-denied, grant-expired, request-initiated, request-accepted, request-denied, request-expired)
date/time in ISO format
date/time in ISO format
value to search for in the fields specified by q_f
restrict searches to one or more fields in: grantee__full_name, account__full_name. searches all fields when unspecified.
sort by grantee, account, state, ends_at. If a field is preceded by a minus sign ('-'), the order will be reversed. Multiple 'o' parameters can be specified to produce a stable result.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Campaign granted/requested
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
Date/time at which the grant/request was created
curl http://localhost:8040/api/energy-utility/portfolios{ "count": 1, "next": null, "previous": null, "results": [ { "grantee": "energy-utility", "account": "supplier-1", "campaign": { "slug": "sustainability", "title": "ESG/Environmental practices", "account": "tspproject" }, "ends_at": "2022-01-01T00:00:00Z", "state": "request-initiated", "api_accept": "/api/supplier-1/portfolios/requests/0000000000000000000000000000000000000002/" } ] }
GET /api/{profile}/portfolios/grants
Lists all grants currently pending initiated by account.
A page number within the paginated result set.
filter by state (grant-initiated, grant-accepted, grant-denied, grant-expired, request-initiated, request-accepted, request-denied, request-expired)
date/time in ISO format
date/time in ISO format
value to search for in the fields specified by q_f
restrict searches to one or more fields in: grantee__full_name, account__full_name. searches all fields when unspecified.
sort by grantee, account, state, ends_at. If a field is preceded by a minus sign ('-'), the order will be reversed. Multiple 'o' parameters can be specified to produce a stable result.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Campaign granted/requested
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
Date/time at which the grant/request was created
Extra meta data (can be stringify JSON)
curl http://localhost:8040/api/supplier-1/portfolios/grants{ "count": 1, "next": null, "previous": null, "results": [ { "grantee": "water-utility", "account": "supplier-1", "campaign": { "slug": "sustainability", "title": "ESG/Environmental practices", "account": "tspproject" }, "ends_at": "2022-01-01T00:00:00Z", "state": "grant-initiated", "api_accept": "/api/water-utility/portfolios/grants/0000000000000000000000000000000000000003/" } ] }
POST /api/{profile}/portfolios/grants
Initiate a grant of data to a grantee
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Campaign granted/requested
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
Date/time at which the grant/request was created
Extra meta data (can be stringify JSON)
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"grantee": {"slug": "energy-utility", "full_name": "Energy Utility"}}' http://localhost:8040/api/supplier-1/portfolios/grants{ "count": 1, "results": [ { "grantee": "water-utility", "account": "supplier-1", "campaign": null, "ends_at": "2022-01-01T00:00:00Z", "state": "grant-initiated", "api_accept": "/api/water-utility/portfolios/grants/0000000000000000000000000000000000000003/" } ] }
POST /api/{profile}/portfolios/grants/{verification_key}
An account has sent its portfolio to a grantee. The grantee accepts the request, making the account's answers up-to-date ends_at available to grantee.
Note that account parameter is the grantee we have send data to here, while the account parameter is the account owning that data when calling POST /api/{account}/grants.
200
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{}' http://localhost:8040/api/energy-utility/portfolios/grants/0123456789abcef{}
DELETE /api/{profile}/portfolios/grants/{verification_key}
204 No Content
curl -X DELETE http://localhost:8040/api/energy-utility/portfolios/grants/0123456789abcefGET /api/{profile}/portfolios/requests
Lists all requests currently pending initiated by account.
A page number within the paginated result set.
filter by state (grant-initiated, grant-accepted, grant-denied, grant-expired, request-initiated, request-accepted, request-denied, request-expired)
date/time in ISO format
date/time in ISO format
value to search for in the fields specified by q_f
restrict searches to one or more fields in: grantee__full_name, account__full_name. searches all fields when unspecified.
sort by grantee, account, state, ends_at. If a field is preceded by a minus sign ('-'), the order will be reversed. Multiple 'o' parameters can be specified to produce a stable result.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Campaign granted/requested
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
Date/time at which the grant/request was created
Extra meta data (can be stringify JSON)
curl http://localhost:8040/api/energy-utility/portfolios/requests{ "count": 3, "next": null, "previous": null, "results": [ { "grantee": "energy-utility", "account": "supplier-1", "campaign": { "slug": "sustainability", "title": "ESG/Environmental practices", "account": "tspproject" }, "ends_at": "2022-01-01T00:00:00Z", "state": "request-denied", "api_accept": null }, { "grantee": "energy-utility", "account": "supplier-1", "campaign": { "slug": "sustainability", "title": "ESG/Environmental practices", "account": "tspproject" }, "ends_at": "2022-01-01T00:00:00Z", "state": "request-initiated", "api_accept": "/api/supplier-1/portfolios/requests/0000000000000000000000000000000000000002/" }, { "grantee": "energy-utility", "account": "andy-shop", "campaign": { "slug": "sustainability", "title": "ESG/Environmental practices", "account": "tspproject" }, "ends_at": "2022-01-01T00:00:00Z", "state": "request-initiated", "api_accept": "/api/andy-shop/portfolios/requests/0000000000000000000000000000000000000004/" } ] }
POST /api/{profile}/portfolios/requests
Initiate a request of data for an account.
Extra meta data (can be stringify JSON)
Extra meta data (can be stringify JSON)
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"accounts": [{"slug": "supplier-1", "full_name": "Supplier 1"}]}' http://localhost:8040/api/energy-utility/portfolios/requests{ "accounts": [ { "slug": "supplier-1", "full_name": "Supplier 1" } ] }
PUT /api/{profile}/portfolios/requests/metadata/{target}
The requestor/grantor uses this API call to add metadata about the request/grant.
Extra meta data (can be stringify JSON)
Campaign granted/requested
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
Date/time at which the grant/request was created
Extra meta data (can be stringify JSON)
curl -X PUT -H 'Content-Type: application/json; charset=UTF-8' -d '{"extra": {"tags": "tier1"}}' http://localhost:8040/api/energy-utility/portfolios/requests/metadata/supplier-1{ "grantee": "energy-utility", "account": "supplier-1", "campaign": { "slug": "sustainability", "title": "ESG/Environmental practices", "account": "tspproject" }, "ends_at": "2022-01-01T00:00:00Z", "state": "request-denied", "api_accept": null, "extra": { "tags": "tier1" } }
POST /api/{profile}/portfolios/requests/{verification_key}
A grantee has made a request to account's portfolio. The account accepts the request, making the account's answers up-to-date ends_at available to grantee.
Note that account is the actual account we are looking to access data from here, while the account parameter is the grantee when calling POST /api/{account}/requests.
200
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{}' http://localhost:8040/api/supplier-1/portfolios/requests/0123456789abcef{}
DELETE /api/{profile}/portfolios/requests/{verification_key}
204 No Content
curl -X DELETE http://localhost:8040/api/supplier-1/portfolios/requests/0123456789abcefGET /api/{profile}/reporting/{campaign}/accessibles
Lists year-by-year accessible responses for reporting profiles
A page number within the paginated result set.
value to search for in the fields specified by q_f
restrict searches to one or more fields in: slug, full_name, email. searches all fields when unspecified.
sort by created_at, full_name. If a field is preceded by a minus sign ('-'), the order will be reversed. Multiple 'o' parameters can be specified to produce a stable result.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique key in the table for the data series
Title of data serie that can be safely used for display in HTML pages
Extra meta data (can be stringify JSON)
Datapoints in the serie
Title of data serie that can be safely used for display in HTML pages
curl http://localhost:8040/api/energy-utility/reporting/sustainability/accessibles{ "count": 1, "next": null, "previous": null, "results": [ { "slug": "andy-shop", "printable_name": "Andy's Shop", "values": [ [ "2023-01-01T00:00:00Z", "complete", 95 ], [ "2022-01-01T00:00:00Z", "complete", 95 ], [ "2021-01-01T00:00:00Z", "declined", null ], [ "2020-01-01T00:00:00Z", "no-data", null ], [ "2019-01-01T00:00:00Z", "no-data", null ], [ "2018-01-01T00:00:00Z", "no-data", null ] ] }, { "slug": "supplier-1", "printable_name": "Supplier 1", "values": [ [ "2023-01-01T00:00:00Z", "complete", 82 ], [ "2022-01-01T00:00:00Z", "complete", 82 ], [ "2021-01-01T00:00:00Z", "declined", null ], [ "2020-01-01T00:00:00Z", "no-data", null ], [ "2019-01-01T00:00:00Z", "no-data", null ], [ "2018-01-01T00:00:00Z", "no-data", null ] ] } ] }
GET /api/{profile}/reporting/{campaign}/by-segments
Returns the number of reporting accounts aggregated by segments.
The scale of the number reported in the tables (ex: 1000 when numbers are reported in thousands)
Unit the measured field is in
Title for the table
Data series
Unique key in the table for the data series
Title of data serie that can be safely used for display in HTML pages
Extra meta data (can be stringify JSON)
Datapoints in the serie
curl http://localhost:8040/api/energy-utility/reporting/sustainability/by-segments{ "title": "Assessments completed by segments", "scale": 1, "unit": "profiles", "results": [ { "slug": "energy-utility", "values": [] }, { "slug": "alliance", "values": [] } ] }
GET /api/{profile}/reporting/{campaign}/compare
A page number within the paginated result set.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl http://localhost:8040/api/energy-utility/reporting/sustainability/compare{ "count": 4, "results": [ { "count": 1, "slug": "sustainability", "path": "/sustainability", "indent": 0, "title": "Core Environment, Social and Governance (ESG) Assessment", "picture": null, "extra": { "pagebreak": true, "tags": [ "scorecard" ], "visibility": [ "public" ], "segments": [ "/sustainability" ] }, "rank": -1, "required": false, "default_unit": null, "ui_hint": null, "nb_respondents": 0, "rate": {}, "opportunity": null }, { "count": 1, "slug": "governance", "path": "/sustainability/governance", "indent": 1, "title": "Strategy & Governance", "picture": "/tspproject/static/img/management-basics.png", "extra": { "segments": [ "/sustainability" ] }, "rank": 1, "required": false, "default_unit": null, "ui_hint": null, "nb_respondents": 0, "rate": {}, "opportunity": null }, { "count": 1, "slug": "esg-strategy-heading", "path": "/sustainability/governance/esg-strategy-heading", "indent": 2, "title": "Environment, Social & Governance (ESG) Strategy", "picture": null, "extra": { "segments": [ "/sustainability" ] }, "rank": 1, "required": false, "default_unit": null, "ui_hint": null, "nb_respondents": 0, "rate": {}, "opportunity": null }, { "count": 1, "slug": "formalized-esg-strategy", "path": "/sustainability/governance/esg-strategy-heading/formalized-esg-strategy", "indent": 3, "title": "(3) Does your company have a formalized ESG strategy?", "picture": "/tspproject/static/img/management-basics.png", "extra": { "segments": [ "/sustainability" ] }, "rank": 4, "required": true, "default_unit": { "slug": "yes-no", "title": "Yes/No", "system": "enum", "choices": [ { "text": "Yes", "descr": "Yes" }, { "text": "No", "descr": "No" } ] }, "ui_hint": "yes-no-comments", "answers": [ { "measured": "true" }, { "measured": "false" } ], "candidates": [], "planned": [], "nb_respondents": 0, "rate": {}, "opportunity": null } ] }
GET /api/{profile}/reporting/{campaign}/compare/{path}
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
curl http://localhost:8040/api/energy-utility/reporting/sustainability/compare/sustainability{ "count": 4, "results": [ { "count": 1, "slug": "sustainability", "path": "/sustainability", "indent": 0, "title": "Core Environment, Social and Governance (ESG) Assessment", "picture": null, "extra": { "pagebreak": true, "tags": [ "scorecard" ], "visibility": [ "public" ], "segments": [ "/sustainability" ] }, "rank": -1, "required": false, "default_unit": null, "ui_hint": null, "nb_respondents": 0, "rate": {}, "opportunity": null }, { "count": 1, "slug": "governance", "path": "/sustainability/governance", "indent": 1, "title": "Strategy & Governance", "picture": "/tspproject/static/img/management-basics.png", "extra": { "segments": [ "/sustainability" ] }, "rank": 1, "required": false, "default_unit": null, "ui_hint": null, "nb_respondents": 0, "rate": {}, "opportunity": null }, { "count": 1, "slug": "esg-strategy-heading", "path": "/sustainability/governance/esg-strategy-heading", "indent": 2, "title": "Environment, Social & Governance (ESG) Strategy", "picture": null, "extra": { "segments": [ "/sustainability" ] }, "rank": 1, "required": false, "default_unit": null, "ui_hint": null, "nb_respondents": 0, "rate": {}, "opportunity": null }, { "count": 1, "slug": "formalized-esg-strategy", "path": "/sustainability/governance/esg-strategy-heading/formalized-esg-strategy", "indent": 3, "title": "(3) Does your company have a formalized ESG strategy?", "picture": "/tspproject/static/img/management-basics.png", "extra": { "segments": [ "/sustainability" ] }, "rank": 4, "required": true, "default_unit": { "slug": "yes-no", "title": "Yes/No", "system": "enum", "choices": [ { "text": "Yes", "descr": "Yes" }, { "text": "No", "descr": "No" } ] }, "ui_hint": "yes-no-comments", "answers": [ { "measured": "true" }, { "measured": "false" } ], "candidates": [], "planned": [], "nb_respondents": 0, "rate": {}, "opportunity": null } ] }
GET /api/{profile}/reporting/{campaign}/completion-rate
Returns the week-by-week percentage of requested accounts that have completed a scorecard.
The scale of the number reported in the tables (ex: 1000 when numbers are reported in thousands)
Unit the measured field is in
Title for the table
Data series
Unique key in the table for the data series
Title of data serie that can be safely used for display in HTML pages
Extra meta data (can be stringify JSON)
Datapoints in the serie
curl http://localhost:8040/api/energy-utility/reporting/sustainability/completion-rate{ "title": "Completion rate (%)", "scale": 1, "unit": "percentage", "results": [ { "slug": "completion-rate", "printable_name": "% completion", "values": [ [ "2020-09-13T00:00:00Z", 0 ], [ "2020-09-20T00:00:00Z", 0 ], [ "2020-09-27T00:00:00Z", 0 ], [ "2020-10-04T00:00:00Z", 0 ], [ "2020-10-11T00:00:00Z", 0 ], [ "2020-10-18T00:00:00Z", 0 ], [ "2020-10-25T00:00:00Z", 0 ], [ "2020-11-01T00:00:00Z", 0 ], [ "2020-11-08T00:00:00Z", 0 ], [ "2020-11-15T00:00:00Z", 0 ], [ "2020-11-22T00:00:00Z", 0 ], [ "2020-11-29T00:00:00Z", 0 ], [ "2020-12-06T00:00:00Z", 0 ], [ "2020-12-13T00:00:00Z", 0 ], [ "2020-12-20T00:00:00Z", 0 ], [ "2020-12-27T00:00:00Z", 0 ], [ "2021-01-03T00:00:00Z", 0 ] ] }, { "slug": "last-year", "printable_name": "vs. last year", "values": [ [ "2019-09-15T00:00:00Z", 0 ], [ "2019-09-22T00:00:00Z", 0 ], [ "2019-09-29T00:00:00Z", 0 ], [ "2019-10-06T00:00:00Z", 0 ], [ "2019-10-13T00:00:00Z", 0 ], [ "2019-10-20T00:00:00Z", 0 ], [ "2019-10-27T00:00:00Z", 0 ], [ "2019-11-03T00:00:00Z", 0 ], [ "2019-11-10T00:00:00Z", 0 ], [ "2019-11-17T00:00:00Z", 0 ], [ "2019-11-24T00:00:00Z", 0 ], [ "2019-12-01T00:00:00Z", 0 ], [ "2019-12-08T00:00:00Z", 0 ], [ "2019-12-15T00:00:00Z", 0 ], [ "2019-12-22T00:00:00Z", 0 ], [ "2019-12-29T00:00:00Z", 0 ], [ "2020-01-05T00:00:00Z", 0 ] ] }, { "slug": "alliance", "printable_name": "Alliance", "values": [ [ "2020-09-13T00:00:00Z", 0 ], [ "2020-09-20T00:00:00Z", 0 ], [ "2020-09-27T00:00:00Z", 0 ], [ "2020-10-04T00:00:00Z", 0 ], [ "2020-10-11T00:00:00Z", 0 ], [ "2020-10-18T00:00:00Z", 0 ], [ "2020-10-25T00:00:00Z", 0 ], [ "2020-11-01T00:00:00Z", 0 ], [ "2020-11-08T00:00:00Z", 0 ], [ "2020-11-15T00:00:00Z", 0 ], [ "2020-11-22T00:00:00Z", 0 ], [ "2020-11-29T00:00:00Z", 0 ], [ "2020-12-06T00:00:00Z", 0 ], [ "2020-12-13T00:00:00Z", 0 ], [ "2020-12-20T00:00:00Z", 0 ], [ "2020-12-27T00:00:00Z", 0 ], [ "2021-01-03T00:00:00Z", 0 ] ] } ] }
GET /api/{profile}/reporting/{campaign}/engagement
reporting_status can be one of: - invited - updated / work-in-progress - completed - declined (to respond) - completed declined to share
A page number within the paginated result set.
value to search for in the fields specified by q_f
restrict searches to one or more fields in: slug, full_name, email. searches all fields when unspecified.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
current reporting status
Most recent time an assessment was updated
Most recent time a reminder was sent
Datetime at which the scorecard was requested
link to the scorecard
curl http://localhost:8040/api/energy-utility/reporting/sustainability/engagement{ "count": 1, "next": null, "previous": null, "results": [ { "grantee": "energy-utility", "account": "supplier-1", "campaign": "sustainability", "created_at": "2022-01-01T00:00:00Z", "ends_at": "2023-01-01T00:00:00Z", "state": "request-denied", "api_accept": null, "reporting_status": "completed", "last_activity_at": "2022-11-01T00:00:00Z", "requested_at": "2022-01-01T00:00:00Z" }, { "grantee": "energy-utility", "account": "andy-shop", "campaign": "sustainability", "created_at": "2022-01-01T00:00:00Z", "ends_at": "2023-01-01T00:00:00Z", "state": "request-accepted", "api_accept": null, "reporting_status": "completed", "last_activity_at": "2022-11-01T00:00:00Z", "requested_at": "2022-01-01T00:00:00Z" } ] }
GET /api/{profile}/reporting/{campaign}/engagement/stats
Returns the engagement as of Today
The scale of the number reported in the tables (ex: 1000 when numbers are reported in thousands)
Unit the measured field is in
Title for the table
Data series
Unique key in the table for the data series
Title of data serie that can be safely used for display in HTML pages
Extra meta data (can be stringify JSON)
Datapoints in the serie
curl http://localhost:8040/api/energy-utility/reporting/sustainability/engagement/stats{ "title": "Completion rate (%)", "scale": 1, "unit": "percentage", "results": [ { "slug": "completion-rate", "printable_name": "% completion", "values": [ [ "2020-09-13T00:00:00Z", 0 ], [ "2020-09-20T00:00:00Z", 0 ], [ "2020-09-27T00:00:00Z", 0 ], [ "2020-10-04T00:00:00Z", 0 ], [ "2020-10-11T00:00:00Z", 0 ], [ "2020-10-18T00:00:00Z", 0 ], [ "2020-10-25T00:00:00Z", 0 ], [ "2020-11-01T00:00:00Z", 0 ], [ "2020-11-08T00:00:00Z", 0 ], [ "2020-11-15T00:00:00Z", 0 ], [ "2020-11-22T00:00:00Z", 0 ], [ "2020-11-29T00:00:00Z", 0 ], [ "2020-12-06T00:00:00Z", 0 ], [ "2020-12-13T00:00:00Z", 0 ], [ "2020-12-20T00:00:00Z", 0 ], [ "2020-12-27T00:00:00Z", 0 ], [ "2021-01-03T00:00:00Z", 0 ] ] }, { "slug": "last-year", "printable_name": "vs. last year", "values": [ [ "2019-09-15T00:00:00Z", 0 ], [ "2019-09-22T00:00:00Z", 0 ], [ "2019-09-29T00:00:00Z", 0 ], [ "2019-10-06T00:00:00Z", 0 ], [ "2019-10-13T00:00:00Z", 0 ], [ "2019-10-20T00:00:00Z", 0 ], [ "2019-10-27T00:00:00Z", 0 ], [ "2019-11-03T00:00:00Z", 0 ], [ "2019-11-10T00:00:00Z", 0 ], [ "2019-11-17T00:00:00Z", 0 ], [ "2019-11-24T00:00:00Z", 0 ], [ "2019-12-01T00:00:00Z", 0 ], [ "2019-12-08T00:00:00Z", 0 ], [ "2019-12-15T00:00:00Z", 0 ], [ "2019-12-22T00:00:00Z", 0 ], [ "2019-12-29T00:00:00Z", 0 ], [ "2020-01-05T00:00:00Z", 0 ] ] }, { "slug": "alliance", "printable_name": "Alliance", "values": [ [ "2020-09-13T00:00:00Z", 0 ], [ "2020-09-20T00:00:00Z", 0 ], [ "2020-09-27T00:00:00Z", 0 ], [ "2020-10-04T00:00:00Z", 0 ], [ "2020-10-11T00:00:00Z", 0 ], [ "2020-10-18T00:00:00Z", 0 ], [ "2020-10-25T00:00:00Z", 0 ], [ "2020-11-01T00:00:00Z", 0 ], [ "2020-11-08T00:00:00Z", 0 ], [ "2020-11-15T00:00:00Z", 0 ], [ "2020-11-22T00:00:00Z", 0 ], [ "2020-11-29T00:00:00Z", 0 ], [ "2020-12-06T00:00:00Z", 0 ], [ "2020-12-13T00:00:00Z", 0 ], [ "2020-12-20T00:00:00Z", 0 ], [ "2020-12-27T00:00:00Z", 0 ], [ "2021-01-03T00:00:00Z", 0 ] ] } ] }
GET /api/{profile}/reporting/{campaign}/matrix/{path}
Uses the total score for each organization as recorded by the assessment surveys and present aggregates by industry sub-sectors (Boxes & enclosures, etc.)
Title for the filter
Extra meta data (can be stringify JSON)
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
Title for the filter
Extra meta data (can be stringify JSON)
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
Title for the filter
Extra meta data (can be stringify JSON)
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
curl http://localhost:8040/api/energy-utility/reporting/sustainability/matrix/totals{ "slug": "totals", "title": "Average scores by supplier industry sub-sector", "cohorts": [ { "slug": "/portfolio-a", "title": "Portfolio A", "tags": null, "predicates": [], "likely_metric": "/app/energy-utility/portfolios/portfolio-a/" } ] }
PUT /api/{profile}/reporting/{campaign}/matrix/{path}
Title for the filter
Extra meta data (can be stringify JSON)
Title for the filter
Extra meta data (can be stringify JSON)
Title for the filter
Extra meta data (can be stringify JSON)
Title for the filter
Extra meta data (can be stringify JSON)
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
Title for the filter
Extra meta data (can be stringify JSON)
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
Title for the filter
Extra meta data (can be stringify JSON)
Name that can be safely used for display in HTML pages
URL location of the profile picture
Extra meta data (can be stringify JSON)
rank in filter
curl -X PUT -H 'Content-Type: application/json; charset=UTF-8' -d '{"title": "Average scores by supplier industry sub-sector", "cohorts": []}' http://localhost:8040/api/energy-utility/reporting/sustainability/matrix/languages{ "slug": "languages", "title": "All cohorts for all questions", "cohorts": [] }
DELETE /api/{profile}/reporting/{campaign}/matrix/{path}
204 No Content
curl -X DELETE http://localhost:8040/api/energy-utility/reporting/sustainability/matrix/languagesGET /api/{profile}/sample
Returns all samples for a profile
A page number within the paginated result set.
date/time in ISO format
date/time in ISO format
filter by state (active, completed)
sort by created_at, campaign__title, is_frozen. If a field is preceded by a minus sign ('-'), the order will be reversed. Multiple 'o' parameters can be specified to produce a stable result.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Campaign this sample is part of
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
Unique identifier for the sample. It can be used in a URL.
Account this sample belongs to
Date/time of creation (in ISO format)
Date/time of last update (in ISO format)
When True, answers to that sample cannot be updated.
URL at which the response is visible
Profiles with which sample was shared
curl http://localhost:8040/api/supplier-1/sample{ "count": 1, "previous": null, "next": null, "results": [ { "slug": "46f66f70f5ad41b29c4df08f683a9a7a", "created_at": "2018-01-24T17:03:34.926193Z", "campaign": "sustainability", "is_frozen": false, "extra": null } ] }
POST /api/{profile}/sample
Creates a new sample to record qualitative and/or quantitative data.
Campaign this sample is part of.
Campaign this sample is part of
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
Unique identifier for the sample. It can be used in a URL.
Account this sample belongs to
Date/time of creation (in ISO format)
Date/time of last update (in ISO format)
When True, answers to that sample cannot be updated.
URL at which the response is visible
Profiles with which sample was shared
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{}' http://localhost:8040/api/supplier-1/sample{ "slug": "46f66f70f5ad41b29c4df08f683a9a7a", "created_at": "2018-01-24T17:03:34.926193Z", "campaign": "sustainability" }
GET /api/{profile}/sample/{sample}
Returns top level information about a sample.
Campaign this sample is part of
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
Unique identifier for the sample. It can be used in a URL.
Account this sample belongs to
Date/time of creation (in ISO format)
Date/time of last update (in ISO format)
When True, answers to that sample cannot be updated.
URL at which the response is visible
Profiles with which sample was shared
curl http://localhost:8040/api/supplier-1/sample/46f66f70f5ad41b29c4df08f683a9a7a{ "slug": "46f66f70f5ad41b29c4df08f683a9a7a", "created_at": "2018-01-24T17:03:34.926193Z", "updated_at": "2018-01-24T17:03:34.926193Z", "is_frozen": false, "account": "supplier-1", "campaign": { "slug": "sustainability", "title": "ESG/Environmental practices" } }
GET /api/{profile}/sample/{sample}/answers
The list returned contains at least one measurement for each question in the campaign. If there are no measurement yet on a question, measured will be null.
There might be more than one measurement per question as long as there are no duplicated unit per question. For example, to the question adjust-air-fuel-ratio, there could be a measurement with unit assessment (Mostly Yes/ Yes / No / Mostly No) and a measurement with unit freetext (i.e. a comment).
The {sample} must belong to {organization}.
{path} can be used to filter the tree of questions by a prefix.
A page number within the paginated result set.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
Question the answer refers to
Unique identifier that can be used in URL
Short description
Unique identifier that can be used in a URL
Short description suitable for display
One of standard (metric system), imperial, rank, enum, or freetext
short name for the enumerated value (as used in source code)
long form description of the enumerated value (for help tooltips)
Hint for the user interface on how to present the input field
Whether an answer is required or not.
curl http://localhost:8040/api/supplier-1/sample/46f66f70f5ad41b29c4df08f683a9a7a/answers{ "count": 3, "previous": null, "next": null, "results": [ { "question": { "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "required": true, "measured": "yes", "unit": "assessment", "created_at": "2020-09-28T00:00:00.000000Z", "collected_by": "steve" }, { "question": { "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "measured": "Policy document on the public website", "unit": "freetext", "created_at": "2020-09-28T00:00:00.000000Z", "collected_by": "steve" }, { "question": { "path": "/construction/production/adjust-air-fuel-ratio", "title": "Adjust Air fuel ratio", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "required": true, "measured": null, "unit": null } ] }
GET /api/{profile}/sample/{sample}/answers/{path}
The list returned contains at least one measurement for each question in the campaign. If there are no measurement yet on a question, measured will be null.
There might be more than one measurement per question as long as there are no duplicated unit per question. For example, to the question adjust-air-fuel-ratio, there could be a measurement with unit assessment (Mostly Yes/ Yes / No / Mostly No) and a measurement with unit freetext (i.e. a comment).
The {sample} must belong to {organization}.
{path} can be used to filter the tree of questions by a prefix.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
Question the answer refers to
Unique identifier that can be used in URL
Short description
Unique identifier that can be used in a URL
Short description suitable for display
One of standard (metric system), imperial, rank, enum, or freetext
short name for the enumerated value (as used in source code)
long form description of the enumerated value (for help tooltips)
Hint for the user interface on how to present the input field
Whether an answer is required or not.
curl http://localhost:8040/api/supplier-1/sample/46f66f70f5ad41b29c4df08f683a9a7a/answers/construction{ "count": 3, "previous": null, "next": null, "results": [ { "question": { "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "required": true, "measured": "yes", "unit": "assessment", "created_at": "2020-09-28T00:00:00.000000Z", "collected_by": "steve" }, { "question": { "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "measured": "Policy document on the public website", "unit": "freetext", "created_at": "2020-09-28T00:00:00.000000Z", "collected_by": "steve" }, { "question": { "path": "/construction/production/adjust-air-fuel-ratio", "title": "Adjust Air fuel ratio", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "required": true, "measured": null, "unit": null } ] }
POST /api/{profile}/sample/{sample}/answers/{path}
This API end-point attaches a measurement (measured field) in unit (meters, kilograms, etc.) to a question (also called metric) named {path} as part of a {sample}.
If a measurement with that unit already exists for the couple ({path}, {sample}), the previous measurement is replaced, otherwise it is added.
If unit is not specified, the default unit for the question is used.
The {sample} must belong to {organization} and be updatable.
Unit the measured field is in
measurement in unit
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{"measured": "mostly-no", "unit": "assessment"}' http://localhost:8040/api/supplier-1/sample/724bf9648af6420ba79c8a37f962e97e/answers/construction{ "created_at": "2020-09-28T00:00:00.000000Z", "collected_by": "steve", "measured": "mostly-no", "unit": "assessment" }
GET /api/{profile}/sample/{sample}/benchmarks
Returns a list of graphs with anonymized performance of peers for paths marked as visible (see ::ref::api_score).
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
Unique key in the table for the data series
Title of data serie that can be safely used for display in HTML pages
Extra meta data (can be stringify JSON)
Datapoints in the serie
curl http://localhost:8040/api/supplier-1/sample/ce6dc2c4cf6b40dbacef91fa3e934eed/benchmarks{ "avg_normalized_score": 50, "highest_normalized_score": 100, "results": [ { "slug": "totals", "title": "Total Score", "nb_answers": 4, "nb_questions": 4, "nb_respondents": 2, "numerator": 12.0, "improvement_numerator": 8.0, "denominator": 26.0, "normalized_score": 46, "improvement_score": 30, "score_weight": 1.0, "highest_normalized_score": 88, "avg_normalized_score": 67, "created_at": "2017-08-02T20:18:19.089", "distribution": { "y": [ 0, 1, 0, 1 ], "x": [ "0-25%", "25-50%", "50-75%", "75-100%" ], "organization_rate": "25-50%" } }, { "slug": "energy-efficiency-management-basics", "title": "Management", "text": "/media/envconnect/management-basics.png", "tag": "management", "score_weight": 1.0 }, { "slug": "process-heating", "title": "Process heating", "text": "/media/envconnect/process-heating.png", "nb_questions": 4, "nb_answers": 4, "nb_respondents": 2, "numerator": 12.0, "improvement_numerator": 8.0, "denominator": 26.0, "normalized_score": 46, "improvement_score": 12, "highest_normalized_score": 88, "avg_normalized_score": 67, "created_at": "2017-08-02T20:18:19.089", "distribution": { "y": [ 0, 1, 0, 1 ], "x": [ "0-25%", "25-50%", "50-75%", "75-100%" ], "organization_rate": "25-50%" }, "score_weight": 1.0 } ] }
GET /api/{profile}/sample/{sample}/benchmarks/{path}
XXX change resp to a {count:, results:} format.
Returns a list of graphs with anonymized performance of peers for paths marked as visible (see ::ref::api_score).
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
Unique key in the table for the data series
Title of data serie that can be safely used for display in HTML pages
Extra meta data (can be stringify JSON)
Datapoints in the serie
curl http://localhost:8040/api/supplier-1/sample/ce6dc2c4cf6b40dbacef91fa3e934eed/benchmarks/boxes-enclosures{ "avg_normalized_score": 50, "highest_normalized_score": 100, "results": [ { "slug": "totals", "title": "Total Score", "nb_answers": 4, "nb_questions": 4, "nb_respondents": 2, "numerator": 12.0, "improvement_numerator": 8.0, "denominator": 26.0, "normalized_score": 46, "improvement_score": 30, "score_weight": 1.0, "highest_normalized_score": 88, "avg_normalized_score": 67, "created_at": "2017-08-02T20:18:19.089", "distribution": { "y": [ 0, 1, 0, 1 ], "x": [ "0-25%", "25-50%", "50-75%", "75-100%" ], "organization_rate": "25-50%" } }, { "slug": "energy-efficiency-management-basics", "title": "Management", "text": "/media/envconnect/management-basics.png", "tag": "management", "score_weight": 1.0 }, { "slug": "process-heating", "title": "Process heating", "text": "/media/envconnect/process-heating.png", "nb_questions": 4, "nb_answers": 4, "nb_respondents": 2, "numerator": 12.0, "improvement_numerator": 8.0, "denominator": 26.0, "normalized_score": 46, "improvement_score": 12, "highest_normalized_score": 88, "avg_normalized_score": 67, "created_at": "2017-08-02T20:18:19.089", "distribution": { "y": [ 0, 1, 0, 1 ], "x": [ "0-25%", "25-50%", "50-75%", "75-100%" ], "organization_rate": "25-50%" }, "score_weight": 1.0 } ] }
GET /api/{profile}/sample/{sample}/candidates
The list returned contains at least one answer for each question in the campaign. If there are no answer yet on a question, measured will be null.
There might be more than one answer per question as long as there are no duplicated unit per question. For example, to the question adjust-air-fuel-ratio, there could be an answer with unit assessment (Mostly Yes/ Yes / No / Mostly No) and an answer with unit freetext (i.e. a comment).
The sample must belong to organization.
path can be used to filter the tree of questions by a prefix.
A page number within the paginated result set.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
Question the answer refers to
Unique identifier that can be used in URL
Short description
Unique identifier that can be used in a URL
Short description suitable for display
One of standard (metric system), imperial, rank, enum, or freetext
short name for the enumerated value (as used in source code)
long form description of the enumerated value (for help tooltips)
Hint for the user interface on how to present the input field
Whether an answer is required or not.
curl http://localhost:8040/api/supplier-1/sample/46f66f70f5ad41b29c4df08f683a9a7a/candidates{ "count": 3, "previous": null, "next": null, "results": [ { "question": { "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "required": true, "measured": "yes", "unit": "assessment", "created_at": "2020-09-28T00:00:00.000000Z", "collected_by": "steve" }, { "question": { "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "measured": "Policy document on the public website", "unit": "freetext", "created_at": "2020-09-28T00:00:00.000000Z", "collected_by": "steve" }, { "question": { "path": "/construction/production/adjust-air-fuel-ratio", "title": "Adjust Air fuel ratio", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "required": true, "measured": null, "unit": null } ] }
POST /api/{profile}/sample/{sample}/candidates
The list returned contains at least one answer for each question in the campaign. If there are no answer yet on a question, measured will be null.
There might be more than one answer per question as long as there are no duplicated unit per question. For example, to the question adjust-air-fuel-ratio, there could be an answer with unit assessment (Mostly Yes/ Yes / No / Mostly No) and an answer with unit freetext (i.e. a comment).
The sample must belong to organization.
path can be used to filter the tree of questions by a prefix.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
Question the answer refers to
Unique identifier that can be used in URL
Short description
Unique identifier that can be used in a URL
Short description suitable for display
One of standard (metric system), imperial, rank, enum, or freetext
short name for the enumerated value (as used in source code)
long form description of the enumerated value (for help tooltips)
Hint for the user interface on how to present the input field
Whether an answer is required or not.
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{}' http://localhost:8040/api/supplier-1/sample/46f66f70f5ad41b29c4df08f683a9a7a/candidates{ "count": 3, "previous": null, "next": null, "results": [ { "question": { "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "required": true, "measured": "yes", "unit": "assessment", "created_at": "2020-09-28T00:00:00.000000Z", "collected_by": "steve" }, { "question": { "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "measured": "Policy document on the public website", "unit": "freetext", "created_at": "2020-09-28T00:00:00.000000Z", "collected_by": "steve" }, { "question": { "path": "/construction/production/adjust-air-fuel-ratio", "title": "Adjust Air fuel ratio", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "required": true, "measured": null, "unit": null } ] }
GET /api/{profile}/sample/{sample}/candidates/{path}
The list returned contains at least one answer for each question in the campaign. If there are no answer yet on a question, measured will be null.
There might be more than one answer per question as long as there are no duplicated unit per question. For example, to the question adjust-air-fuel-ratio, there could be an answer with unit assessment (Mostly Yes/ Yes / No / Mostly No) and an answer with unit freetext (i.e. a comment).
The sample must belong to organization.
path can be used to filter the tree of questions by a prefix.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
Question the answer refers to
Unique identifier that can be used in URL
Short description
Unique identifier that can be used in a URL
Short description suitable for display
One of standard (metric system), imperial, rank, enum, or freetext
short name for the enumerated value (as used in source code)
long form description of the enumerated value (for help tooltips)
Hint for the user interface on how to present the input field
Whether an answer is required or not.
curl http://localhost:8040/api/supplier-1/sample/46f66f70f5ad41b29c4df08f683a9a7a/candidates/construction{ "count": 3, "previous": null, "next": null, "results": [ { "question": { "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "required": true, "measured": "yes", "unit": "assessment", "created_at": "2020-09-28T00:00:00.000000Z", "collected_by": "steve" }, { "question": { "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "measured": "Policy document on the public website", "unit": "freetext", "created_at": "2020-09-28T00:00:00.000000Z", "collected_by": "steve" }, { "question": { "path": "/construction/production/adjust-air-fuel-ratio", "title": "Adjust Air fuel ratio", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "required": true, "measured": null, "unit": null } ] }
POST /api/{profile}/sample/{sample}/candidates/{path}
The list returned contains at least one answer for each question in the campaign. If there are no answer yet on a question, measured will be null.
There might be more than one answer per question as long as there are no duplicated unit per question. For example, to the question adjust-air-fuel-ratio, there could be an answer with unit assessment (Mostly Yes/ Yes / No / Mostly No) and an answer with unit freetext (i.e. a comment).
The sample must belong to organization.
path can be used to filter the tree of questions by a prefix.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
Question the answer refers to
Unique identifier that can be used in URL
Short description
Unique identifier that can be used in a URL
Short description suitable for display
One of standard (metric system), imperial, rank, enum, or freetext
short name for the enumerated value (as used in source code)
long form description of the enumerated value (for help tooltips)
Hint for the user interface on how to present the input field
Whether an answer is required or not.
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{}' http://localhost:8040/api/supplier-1/sample/46f66f70f5ad41b29c4df08f683a9a7a/candidates/construction{ "count": 3, "previous": null, "next": null, "results": [ { "question": { "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "required": true, "measured": "yes", "unit": "assessment", "created_at": "2020-09-28T00:00:00.000000Z", "collected_by": "steve" }, { "question": { "path": "/construction/governance/the-assessment-process-is-rigorous", "title": "The assessment process is rigorous", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "measured": "Policy document on the public website", "unit": "freetext", "created_at": "2020-09-28T00:00:00.000000Z", "collected_by": "steve" }, { "question": { "path": "/construction/production/adjust-air-fuel-ratio", "title": "Adjust Air fuel ratio", "default_unit": { "slug": "assessment", "title": "assessments", "system": "enum", "choices": [ { "rank": 1, "text": "mostly-yes", "descr": "Mostly yes" }, { "rank": 2, "text": "yes", "descr": "Yes" }, { "rank": 3, "text": "no", "descr": "No" }, { "rank": 4, "text": "mostly-no", "descr": "Mostly no" } ] }, "ui_hint": "radio" }, "required": true, "measured": null, "unit": null } ] }
GET /api/{profile}/sample/{sample}/content
The list returned contains at least one measurement for each question in the campaign. If there are no measurement yet on a question, measured will be null.
There might be more than one measurement per question as long as there are no duplicated unit per question. For example, to the question adjust-air-fuel-ratio, there could be a measurement with unit assessment (Mostly Yes/ Yes / No / Mostly No) and a measurement with unit freetext (i.e. a comment).
The {sample} must belong to {organization}.
{path} can be used to filter the tree of questions by a prefix.
A page number within the paginated result set.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
curl http://localhost:8040/api/andy-shop/sample/f1e2e916eb494b90f9ff0a36982342/content{ "count": 4, "results": [ { "count": 1, "slug": "sustainability", "path": "/sustainability", "indent": 0, "title": "Core Environment, Social and Governance (ESG) Assessment", "picture": null, "extra": { "pagebreak": true, "tags": [ "scorecard" ], "visibility": [ "public" ], "segments": [ "/sustainability" ] }, "rank": -1, "required": false, "default_unit": null, "ui_hint": null, "nb_respondents": 0, "rate": {}, "opportunity": null }, { "count": 1, "slug": "governance", "path": "/sustainability/governance", "indent": 1, "title": "Strategy & Governance", "picture": "/tspproject/static/img/management-basics.png", "extra": { "segments": [ "/sustainability" ] }, "rank": 1, "required": false, "default_unit": null, "ui_hint": null, "nb_respondents": 0, "rate": {}, "opportunity": null }, { "count": 1, "slug": "esg-strategy-heading", "path": "/sustainability/governance/esg-strategy-heading", "indent": 2, "title": "Environment, Social & Governance (ESG) Strategy", "picture": null, "extra": { "segments": [ "/sustainability" ] }, "rank": 1, "required": false, "default_unit": null, "ui_hint": null, "nb_respondents": 0, "rate": {}, "opportunity": null }, { "count": 1, "slug": "formalized-esg-strategy", "path": "/sustainability/governance/esg-strategy-heading/formalized-esg-strategy", "indent": 3, "title": "(3) Does your company have a formalized ESG strategy?", "picture": "/tspproject/static/img/management-basics.png", "extra": { "segments": [ "/sustainability" ] }, "rank": 4, "required": true, "default_unit": { "slug": "yes-no", "title": "Yes/No", "system": "enum", "choices": [ { "text": "Yes", "descr": "Yes" }, { "text": "No", "descr": "No" } ] }, "ui_hint": "yes-no-comments", "answers": [], "candidates": [], "planned": [], "nb_respondents": 0, "rate": {}, "opportunity": null } ] }
GET /api/{profile}/sample/{sample}/content/{path}
The list returned contains at least one measurement for each question in the campaign. If there are no measurement yet on a question, measured will be null.
There might be more than one measurement per question as long as there are no duplicated unit per question. For example, to the question adjust-air-fuel-ratio, there could be a measurement with unit assessment (Mostly Yes/ Yes / No / Mostly No) and a measurement with unit freetext (i.e. a comment).
The {sample} must belong to {organization}.
{path} can be used to filter the tree of questions by a prefix.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Unique identifier that can be used in URL paths
path from the root of content tree
level in the content tree
Account that can edit the page element
Title of the page element
Picture icon that can be displayed alongside the title
Extra meta data (can be stringify JSON)
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
Unit the measured field is in
measurement in unit
Date/time of creation (in ISO format)
User that collected the answer
curl http://localhost:8040/api/andy-shop/sample/f1e2e916eb494b90f9ff0a36982342/content/sustainability{ "count": 4, "results": [ { "count": 1, "slug": "sustainability", "path": "/sustainability", "indent": 0, "title": "Core Environment, Social and Governance (ESG) Assessment", "picture": null, "extra": { "pagebreak": true, "tags": [ "scorecard" ], "visibility": [ "public" ], "segments": [ "/sustainability" ] }, "rank": -1, "required": false, "default_unit": null, "ui_hint": null, "nb_respondents": 0, "rate": {}, "opportunity": null }, { "count": 1, "slug": "governance", "path": "/sustainability/governance", "indent": 1, "title": "Strategy & Governance", "picture": "/tspproject/static/img/management-basics.png", "extra": { "segments": [ "/sustainability" ] }, "rank": 1, "required": false, "default_unit": null, "ui_hint": null, "nb_respondents": 0, "rate": {}, "opportunity": null }, { "count": 1, "slug": "esg-strategy-heading", "path": "/sustainability/governance/esg-strategy-heading", "indent": 2, "title": "Environment, Social & Governance (ESG) Strategy", "picture": null, "extra": { "segments": [ "/sustainability" ] }, "rank": 1, "required": false, "default_unit": null, "ui_hint": null, "nb_respondents": 0, "rate": {}, "opportunity": null }, { "count": 1, "slug": "formalized-esg-strategy", "path": "/sustainability/governance/esg-strategy-heading/formalized-esg-strategy", "indent": 3, "title": "(3) Does your company have a formalized ESG strategy?", "picture": "/tspproject/static/img/management-basics.png", "extra": { "segments": [ "/sustainability" ] }, "rank": 4, "required": true, "default_unit": { "slug": "yes-no", "title": "Yes/No", "system": "enum", "choices": [ { "text": "Yes", "descr": "Yes" }, { "text": "No", "descr": "No" } ] }, "ui_hint": "yes-no-comments", "answers": [], "candidates": [], "planned": [], "nb_respondents": 0, "rate": {}, "opportunity": null } ] }
POST /api/{profile}/sample/{sample}/freeze
A frozen sample cannot be edited to add and/or update answers.
Profiles with which sample was shared
Campaign this sample is part of
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
Unique identifier for the sample. It can be used in a URL.
Account this sample belongs to
Date/time of creation (in ISO format)
Date/time of last update (in ISO format)
When True, answers to that sample cannot be updated.
URL at which the response is visible
Profiles with which sample was shared
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{}' http://localhost:8040/api/supplier-1/sample/0123456789abcdef/freeze{ "slug": "0123456789abcdef", "account": "supplier-1", "created_at": "2020-01-01T00:00:00Z", "is_frozen": true, "campaign": null, "updated_at": "2020-01-01T00:00:00Z" }
POST /api/{profile}/sample/{sample}/freeze/{path}
A frozen sample cannot be edited to add and/or update answers.
Profiles with which sample was shared
Campaign this sample is part of
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
Unique identifier for the sample. It can be used in a URL.
Account this sample belongs to
Date/time of creation (in ISO format)
Date/time of last update (in ISO format)
When True, answers to that sample cannot be updated.
URL at which the response is visible
Profiles with which sample was shared
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{}' http://localhost:8040/api/supplier-1/sample/0123456789abcdef/freeze/construction{ "slug": "0123456789abcdef", "account": "supplier-1", "created_at": "2020-01-01T00:00:00Z", "is_frozen": true, "campaign": null, "updated_at": "2020-01-01T00:00:00Z" }
POST /api/{profile}/sample/{sample}/reset
The sample must belong to organization.
path can be used to filter the tree of questions by a prefix.
Profiles with which sample was shared
Campaign this sample is part of
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
Unique identifier for the sample. It can be used in a URL.
Account this sample belongs to
Date/time of creation (in ISO format)
Date/time of last update (in ISO format)
When True, answers to that sample cannot be updated.
URL at which the response is visible
Profiles with which sample was shared
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{}' http://localhost:8040/api/supplier-1/sample/46f66f70f5ad41b29c4df08f683a9a7a/reset{ "slug": "46f66f70f5ad41b29c4df08f683a9a7a", "created_at": "2018-01-24T17:03:34.926193Z", "campaign": "sustainability" }
POST /api/{profile}/sample/{sample}/reset/{path}
The sample must belong to organization.
path can be used to filter the tree of questions by a prefix.
Profiles with which sample was shared
Campaign this sample is part of
Unique identifier that can be used in a URL
Account this sample belongs to.
Title of the campaign as displayed in user interfaces
Long form description displayed to users responding to the campaign
Whether the campaign is available or not
Unique identifier for the sample. It can be used in a URL.
Account this sample belongs to
Date/time of creation (in ISO format)
Date/time of last update (in ISO format)
When True, answers to that sample cannot be updated.
URL at which the response is visible
Profiles with which sample was shared
curl -X POST -H 'Content-Type: application/json; charset=UTF-8' -d '{}' http://localhost:8040/api/supplier-1/sample/46f66f70f5ad41b29c4df08f683a9a7a/reset/construction{ "slug": "46f66f70f5ad41b29c4df08f683a9a7a", "created_at": "2018-01-24T17:03:34.926193Z", "campaign": "sustainability" }
GET /api/{profile}/sample/{sample}/respondents
The list returned contains the information about the users who answered at least one question.
The {sample} must belong to {organization}.
{path} can be used to filter the tree of questions by a prefix.
A page number within the paginated result set.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Effectively the username. The variable is named `slug` such that front-end code can be re-used between Organization and User records.
E-mail address for the user
Full name for the contact (effectively first name followed by last name)
Date/time of creation (in ISO format)
Date/time of last login (in ISO format)
curl http://localhost:8040/api/supplier-1/sample/46f66f70f5ad41b29c4df08f683a9a7a/respondents{ "count": 1, "previous": null, "next": null, "results": [ { "slug": "steve", "full_name": "Steve" } ] }
GET /api/{profile}/sample/{sample}/respondents/{path}
The list returned contains the information about the users who answered at least one question.
The {sample} must belong to {organization}.
{path} can be used to filter the tree of questions by a prefix.
Total number of items in the dataset
URL to previous page of results
URL to next page of results
items in current page
Effectively the username. The variable is named `slug` such that front-end code can be re-used between Organization and User records.
E-mail address for the user
Full name for the contact (effectively first name followed by last name)
Date/time of creation (in ISO format)
Date/time of last login (in ISO format)
curl http://localhost:8040/api/supplier-1/sample/46f66f70f5ad41b29c4df08f683a9a7a/respondents/construction{ "count": 1, "previous": null, "next": null, "results": [ { "slug": "steve", "full_name": "Steve" } ] }