{"data":{"markdownRemark":{"html":"

GET

\n

Given the id, returns the array of ticks, time-steps within the simulation.

\n

Request

\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameLocated inDescriptionRequiredSchema
idpathID of simulationYesstring
\n

Example request

\n
curl -X GET http://localhost:8080/api/simulations/batch/{id}/ticks \\\n  -H 'Accept: application/json'
\n

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusMeaningDescriptionSchema
200OKResponse completed sucessfullyInline
404Not FoundSimulation not foundInline
\n

Response Schema

\n

Status Code 200

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequired
ticks[object]true
» timestring(date-time)
» tickinteger
» dataobject
»» timeobjecttrue
»»» startstring(date-time)true
»»» endstring(date-time)true
»»» timeStepintegertrue
»»» ticksintegertrue
»»» macroStepintegertrue
\n

Example 200 response body

\n
{\n    \"ticks\": [\n        {\n            \"time\": \"2018-01-01T00:00Z\",\n            \"tick\": 0,\n            \"data\": {\n                \"aliveCells\": {\n                    \"min\": 204,\n                    \"max\": 204,\n                    \"mean\": 204,\n                    \"median\": 204,\n                    \"lower_quartile\": 204,\n                    \"upper_quartile\": 204,\n                    \"std\": 0,\n                    \"variance\": 0\n                },\n                \"time\": {\n                    \"start\": \"2018-01-01T00:00Z\",\n                    \"end\": \"2023-01-01T00:00Z\",\n                    \"timeStep\": 1,\n                    \"timeUnit\": \"Months\",\n                    \"ticks\": 60,\n                    \"macroStep\": 25\n                }\n            }\n        },\n    { ... }\n  ]\n}
\n
\n

Status Code 404

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequired
messagestringtrue
\n

Example 404 response body

\n
{\n  \"message\": \"Could not find simulation '5af75d69-1926-4ef2-a56f-07ad5f85673b'\"\n}
","headings":[{"value":"GET","depth":1},{"value":"Request","depth":2},{"value":"Parameters","depth":3},{"value":"Response","depth":2},{"value":"Response Schema","depth":3}],"frontmatter":{"title":"/api/simulations/batch/{id}/ticks","toc":null,"experimental":null}},"site":{"siteMetadata":{"title":"Simudyne Docs","latestVersion":"2.6"}}},"pageContext":{"absolutePath":"/home/vsts/work/1/s/content/2.3/rest_api/batch/api_simulations_batch_id_ticks.md","versioned":true,"version":"2.3","kind":"rest_api","pagePath":"/rest_api/batch/api_simulations_batch_id_ticks","chronology":{"prev":{"name":"/api/simulations/batch/{id}","path":"/rest_api/batch/api_simulations_batch_id"},"next":{"name":"Scenario Rest API","path":"/rest_api/scenario"}},"lastUpdated":"2026-04-21T13:56:54.845Z"}}