Segment Analytics

GET https://{{instance_url}}/segments/data_series?segment_id={{segment_identifier}}&length=14&ending_at=2018-06-27T23:59:59-5:00

This endpoint allows you to retrieve a daily series of the size of a segment over time for a segment.

Request Components

• Segment Identifier

Response

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "data" : [
        {
            "time" : (string) date as ISO 8601 date,
            "size" : (int) size of the segment on that date
        },
        ...
    ]
}

Request Params

Segment API identifier. | | length | number | | (Required) Integer

Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive. | | ending_at | string | | (Optional) DateTime (ISO 8601 string)

Point in time when the data series should end - defaults to time of the request. |

HEADERS