Get segments
GET
https://api.lytics.io/v2/segmentGet a list of segments for an account
Sample Response
Status|200 OK
{
"_meta": {},
"data": [
{
"account_id": "string",
"aid": 0,
"ast": {
"args": [
{}
],
"ident": "string",
"op": "string",
"val": "string"
},
"author_id": "string",
"category": "string",
"created": "string",
"datemath_calc": true,
"deleted": true,
"description": "string",
"field_changes_fields": [
"string"
],
"fields": [
"string"
],
"forward_datemath": true,
"groups": [
"string"
],
"id": "string",
"identities": [
"string"
],
"includes": [
"string"
],
"invalid": true,
"invalid_reason": "string",
"is_public": true,
"kind": "string",
"name": "string",
"public_name": "string",
"ql_resolved": "string",
"save_hist": true,
"schedule_exit": true,
"segment_ql": "string",
"size": 0,
"slug_name": "string",
"table": "string",
"tags": [
"string"
],
"updated": "string",
"withs_ql": "string"
}
],
"request_id": "string",
"status": 0
}Create segment
POST
https://api.lytics.io/v2/segmentCreate a segment
Sample Request
{
"account_id": "string",
"aid": 0,
"ast": {
"args": [
{}
],
"ident": "string",
"op": "string",
"val": "string"
},
"author_id": "string",
"category": "string",
"created": "string",
"datemath_calc": true,
"deleted": true,
"description": "string",
"field_changes_fields": [
"string"
],
"fields": [
"string"
],
"forward_datemath": true,
"groups": [
"string"
],
"id": "string",
"identities": [
"string"
],
"includes": [
"string"
],
"invalid": true,
"invalid_reason": "string",
"is_public": true,
"kind": "string",
"name": "string",
"public_name": "string",
"ql_resolved": "string",
"save_hist": true,
"schedule_exit": true,
"segment_ql": "string",
"size": 0,
"slug_name": "string",
"table": "string",
"tags": [
"string"
],
"updated": "string",
"withs_ql": "string"
}Sample Response
Status|201 Created
{
"_meta": {},
"data": {
"account_id": "string",
"aid": 0,
"ast": {
"args": [
{}
],
"ident": "string",
"op": "string",
"val": "string"
},
"author_id": "string",
"category": "string",
"created": "string",
"datemath_calc": true,
"deleted": true,
"description": "string",
"field_changes_fields": [
"string"
],
"fields": [
"string"
],
"forward_datemath": true,
"groups": [
"string"
],
"id": "string",
"identities": [
"string"
],
"includes": [
"string"
],
"invalid": true,
"invalid_reason": "string",
"is_public": true,
"kind": "string",
"name": "string",
"public_name": "string",
"ql_resolved": "string",
"save_hist": true,
"schedule_exit": true,
"segment_ql": "string",
"size": 0,
"slug_name": "string",
"table": "string",
"tags": [
"string"
],
"updated": "string",
"withs_ql": "string"
},
"request_id": "string",
"status": 0
}Delete segments
DELETE
https://api.lytics.io/v2/segmentDelete multiple segments
Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"deleted": [
"string"
],
"not_deleted": [
"string"
],
"segments": [
{
"deleted": true,
"id": "string",
"reason": "string",
"segments": {
"property1": [
"string"
],
"property2": [
"string"
]
}
}
]
},
"request_id": "string",
"status": 0
}Add/Remove segment in/from the exclusion list
POST
https://api.lytics.io/v2/segment/exclude/{operation}Adds/Removes the passed segment id in/from the exclusion list. Exclusion list allows to exclude all the users from the segment during the export job. Pass auth_id to scope the exclusion to one authorization; workflow-level and auth-level exclusions are combined, never substituted.
Sample Response
Status|200 OK
{
"_meta": {},
"data": {},
"request_id": "string",
"status": 0
}Get segment
GET
https://api.lytics.io/v2/segment/{id}Get a segment by ID or slug
Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"account_id": "string",
"aid": 0,
"ast": {
"args": [
{}
],
"ident": "string",
"op": "string",
"val": "string"
},
"author_id": "string",
"category": "string",
"created": "string",
"datemath_calc": true,
"deleted": true,
"description": "string",
"field_changes_fields": [
"string"
],
"fields": [
"string"
],
"forward_datemath": true,
"groups": [
"string"
],
"id": "string",
"identities": [
"string"
],
"includes": [
"string"
],
"invalid": true,
"invalid_reason": "string",
"is_public": true,
"kind": "string",
"name": "string",
"public_name": "string",
"ql_resolved": "string",
"save_hist": true,
"schedule_exit": true,
"segment_ql": "string",
"size": 0,
"slug_name": "string",
"table": "string",
"tags": [
"string"
],
"updated": "string",
"withs_ql": "string"
},
"request_id": "string",
"status": 0
}Update segment
PUT
https://api.lytics.io/v2/segment/{id}Update a segment
Sample Request
{
"account_id": "string",
"aid": 0,
"ast": {
"args": [
{}
],
"ident": "string",
"op": "string",
"val": "string"
},
"author_id": "string",
"category": "string",
"created": "string",
"datemath_calc": true,
"deleted": true,
"description": "string",
"field_changes_fields": [
"string"
],
"fields": [
"string"
],
"forward_datemath": true,
"groups": [
"string"
],
"id": "string",
"identities": [
"string"
],
"includes": [
"string"
],
"invalid": true,
"invalid_reason": "string",
"is_public": true,
"kind": "string",
"name": "string",
"public_name": "string",
"ql_resolved": "string",
"save_hist": true,
"schedule_exit": true,
"segment_ql": "string",
"size": 0,
"slug_name": "string",
"table": "string",
"tags": [
"string"
],
"updated": "string",
"withs_ql": "string"
}Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"account_id": "string",
"aid": 0,
"ast": {
"args": [
{}
],
"ident": "string",
"op": "string",
"val": "string"
},
"author_id": "string",
"category": "string",
"created": "string",
"datemath_calc": true,
"deleted": true,
"description": "string",
"field_changes_fields": [
"string"
],
"fields": [
"string"
],
"forward_datemath": true,
"groups": [
"string"
],
"id": "string",
"identities": [
"string"
],
"includes": [
"string"
],
"invalid": true,
"invalid_reason": "string",
"is_public": true,
"kind": "string",
"name": "string",
"public_name": "string",
"ql_resolved": "string",
"save_hist": true,
"schedule_exit": true,
"segment_ql": "string",
"size": 0,
"slug_name": "string",
"table": "string",
"tags": [
"string"
],
"updated": "string",
"withs_ql": "string"
},
"request_id": "string",
"status": 0
}Delete segment
DELETE
https://api.lytics.io/v2/segment/{id}Delete a segment
Sample Response
Status|200 OK
{
"_meta": {},
"data": {},
"request_id": "string",
"status": 0
}